Types

Index

LineItemDetails

The line items of the order.

Fields
line_item_id

string

Required. The ID for this line item.

product_id

string

Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.

gtins[]

string

Optional. The Global Trade Item Numbers.

mpn

string

Optional. The manufacturer part number.

quantity

int64

Required. The quantity of the line item in the order.

product_title

string

Optional. Plain text title of this product.

brand

string

Optional. Brand of the product.

ShipmentLineItemMapping

Represents how many items are in the shipment for the given shipment_id and line_item_id.

Fields
shipment_id

string

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

line_item_id

string

Required. The line item ID.

quantity

int64

Required. The line item quantity in the shipment.

ShippingInfo

The shipping information for the order.

Fields
shipment_id

string

Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.

tracking_id

string

Optional. The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

carrier

string

Optional. The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.

carrier_service

string

Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc.

shipped_time

DateTime

Optional. The time when the shipment was shipped. Include the year and timezone string, if available.

earliest_delivery_promise_time

DateTime

Optional. The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

latest_delivery_promise_time

DateTime

Optional. The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

actual_delivery_time

DateTime

Optional. The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name.

shipping_status

ShippingState

Required. The status of the shipment.

origin_postal_code

string

Required. The origin postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.

origin_region_code

string

Required. The CLDR territory code for the shipping origin.

ShippingState

The current status of the shipments.

Enums
SHIPPING_STATE_UNSPECIFIED The shipping status is not known to business.
SHIPPED All items are shipped.
DELIVERED The shipment is already delivered.