My favorites | English | Sign in

More personalization in Google Friend Connect New!

Google Checkout

XML API Commands for Archiving Orders

Note: This is the latest documentation. The previous version of this page is identical — only the left nav differs.
Overview
Order Processing API Commands
XML Tag Definitions

Overview

Archiving commands enable you to manage the list of orders in your Merchant Center inbox. Archiving commands do not have any impact on an order's status or on the order information that is communicated to the customer.

Order Processing API Commands

<archive-order>

The <archive-order> command instructs Google Checkout to remove an order from your Merchant Center Inbox. We recommend that you only archive orders after they have been delivered or canceled.

<?xml version="1.0" encoding="UTF-8"?>
<archive-order xmlns="http://checkout.google.com/schema/2"
    google-order-number="841171949013218" />

<unarchive-order>

The <unarchive-order> command instructs Google Checkout to return a previously archived order to your Merchant Center Inbox.

The following XML shows a sample <unarchive-order> request:

<?xml version="1.0" encoding="UTF-8"?>
<unarchive-order xmlns="http://checkout.google.com/schema/2"
    google-order-number="841171949013218" />

XML Tag Definitions

Certain symbols may be displayed next to some subtags in the definitions below. These symbols, and their meanings, are:

? = optional subtag
* = zero or more instances of the subtag

archive-order
Definition

The <archive-order> tag indicates a request to archive a particular order. You would archive an order to remove it from your Merchant Center Inbox, indicating that the order has been delivered.

Attributes
NameFormatDescription
google-order-number String The google-order-number attribute contains an ID that uniquely identifies an order.
API Commands Archive Order
Content Format Empty
Example <archive-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/>

unarchive-order
Definition

The <unarchive-order> tag indicates a request to unarchive a particular order. You would use this command to return an order to your Merchant Center Inbox after the order had previously been archived.

Attributes
NameFormatDescription
google-order-number String The google-order-number attribute contains an ID that uniquely identifies an order.
API Commands Unarchive Order
Content Format Complex
Example <unarchive-order xmlns="http://checkout.google.com/schema/2" google-order-number="6014423719"/>