| Site Directory

Google Checkout APIs

Documentation

Developer Tools

Support Resources

HTML API Commands for Archiving Orders

Overview
Order Processing API Commands

archive-order
unarchive-order

HTML Parameter 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.

_type=archive-order
  &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:

_type=unarchive-order
  &google-order-number=841171949013218

HTML Parameter Definitions

The _type parameter identifies the type of API request that is being submitted. Google will send this parameter in any API transaction, including synchronous responses and notifications. You must also send this parameter for all API requests other than Checkout API requests, including all Order Processing API commands.

Valid values for this parameter are:

add-merchant-order-number
add-tracking-data
archive-order
authorization-amount-notification
authorize-order
backorder-items
cancel-items
cancel-order
charge-amount-notification
chargeback-amount-notification
charge-order
checkout-redirect
deliver-order
demo-failure
diagnosis

error
new-order-notification
notification-acknowledgment
order-state-change-notification
process-order
refund-amount-notification
refund-order
request-received
reset-items-shipping-information
return-items
risk-information-notification
send-buyer-message
ship-items
unarchive-order

Note: The value of the type parameter corresponds to the root tag of an XML API request.

Content format for parameter value

Sample use(s)

_type=new-order-notification
_type=ship-items

google-order-number

The <google-order-number> parameter contains an ID, which Google generates, that uniquely identifies an order.

API commands

New Order Notification, Risk Information Notification, Order State Change Notification, Charge Amount Notification, Refund Amount Notification, Chargeback Amount Notification, Authorization Amount Notification, Charge Order, Refund Order, Cancel Order, Authorize Order, Process Order, Deliver Order, Add Tracking Data, Send Buyer Message, Archive Order, Unarchive Order, Add Merchant Order Number, Ship Items, Reset Items Shipping Information, Cancel Items, Return Items, Backorder Items

Content format for parameter value

Sample use(s)

google-order-number=6014423719