Order feed specification

Shopping Actions US + Shopping Actions France

This article explains the data specifications you’ll need to follow to upload order feeds in Merchant Center.

About order feed formatting

  • Order feeds contain actions that represent order status changes. For example, shipping or cancelling an order.
  • Create your feed in a delimited format where the first row contains the attribute name of each column. Each line after must define an action performed on one particular line item of an order.
  • Use English for the name of the attribute and fixed attributes values. For example, the Action attribute may have the fixed value shipped. We recommend using the language of the country of sale for any attribute value without a fixed value, for example, Cancellation Reason Text.
  • Use an underscore or space within an attribute name. For example:, Cancellation_Reason or Cancellation Reason.

Summary of attribute requirements

Attribute name Requirement
Action Required to be either shipped or cancelled.
Google Order Id
Line Item Id
Quantity
Required for all actions.
Shipment Timestamp
Carrier
Tracking Id
May be provided when the action is shipped.
Cancellation Reason Required when the action is cancelled.
Cancellation Reason Text May be provided when the action is cancelled.
Action Id Required when performing the same action multiple times on the same line item.

Attribute requirements

Attribute Format
action

Required
The action performed on the line item.
 

Supported values

  • shipped
  • cancelled
google_order_id

Required
The ID of the order, as found in the order list in Merchant Center or the CSV file you downloaded.

Example 
TEST-1234-56-7890

line_item_id

Required
The ID of the line item, as found in the CSV file you downloaded.

Example
MO52PDSQZ4KCZEYE

quantity

Required
The quantity of the line item that is to be marked as shipped or cancelled in this action.

Syntax
A positive integer

shipment_timestamp

Optional when the Action is shipped
The time when the line item was shipped. Must be specified at least to the nearest hour and include a time zone.

Example
2016-07-11T11:07:31​-08 (for Pacific Standard Time, PST)
2016-07-11T11:07:31​-07 (for Pacific Daylight Time, PDT)
2016-07-11T11:07:31​-05 (for Eastern Standard Time, EST)
2016-07-11T11:07:31​-04 (for Eastern Daylight Time, EDT)
2016-07-11T11:07:31​+01 (for Central European Time, CET)
2016-07-11T11:07:31​Z (for UTC)
 

Syntax

  • Max 25 alphanumeric characters
  • A subset of ISO 8601 
    • YYYY-MM-DDThhZ
    • YYYY-MM-DDThh±hh
    • YYYY-MM-DDThh±hhmm
    • YYYY-MM-DDThh±hh:mm
    • YYYY-MM-DDThh:mmZ
    • YYYY-MM-DDThh:mm±hh
    • YYYY-MM-DDThh:mm±hhmm
    • YYYY-MM-DDThh:mm±hh:mm
    • YYYY-MM-DDThh:mm:ssZ
    • YYYY-MM-DDThh:mm:ss±hh
    • YYYY-MM-DDThh:mm:ss±hhmm
    • YYYY-MM-DDThh:mm:ss±hh:mm
carrier

Optional when the Action is shipped
The carrier used to ship the line item.

Supported values

 

US:

  • cxt
  • deliv
  • dhl
  • dynamex
  • ecourier
  • efw
  • emsy
  • fedex
  • google
  • gsx
  • lasership
  • mpx
  • ont
  • ontrac
  • uds
  • ups
  • usps

France:

  • boxtal
  • bpost
  • chronopost
  • colis prive
  • colissimo
  • DB Schenker
  • dhl express
  • dpd
  • geodis
  • gls
  • la poste
  • tnt
  • ups

 

 

tracking_id

Optional when the Action is shipped
The carrier's tracking ID for the shipment that contains the line item.

Syntax
Max 50 characters

cancellation_reason

Required when the Action is cancelled
The fixed value from the list below that best describes the reason why the line item is being cancelled.

Supported values

  • customer initiated cancel
  • invalid coupon
  • malformed shipping address
  • no inventory
  • other
  • price error
  • shipping price error
  • tax error
  • undeliverable shipping address
  • unsupported po box address
cancellation_reason_text

Optional when the Action is cancelled
Free-form text to describe the cancellation reason in more detail.

Syntax
Max 500 characters

action_id

Optional
Not needed the first time the action is performed on the given line item.

Required

When performing the same action multiple times on the same line item, e.g. when shipping a line item partially, a unique action ID of your choice must be provided for each but the first action.

Syntax
Max 15 characters, case-sensitive

Note
This is to guarantee that a given action is not performed more than once by mistake.

 

 

 

Was this helpful?
How can we improve it?