Index
CreateOrderTrackingSignalRequest(message)OrderTrackingSignal(message)
LineItemDetails
The line items of the order.
| Fields | |
|---|---|
line_item_id |
Required. The ID for this line item. |
product_id |
Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId. |
gtins[] |
Optional. The Global Trade Item Numbers. |
mpn |
Optional. The manufacturer part number. |
quantity |
Required. The quantity of the line item in the order. |
product_title |
Optional. Plain text title of this product. |
brand |
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 |
Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
line_item_id |
Required. The line item ID. |
quantity |
Required. The line item quantity in the shipment. |
ShippingInfo
The shipping information for the order.
| Fields | |
|---|---|
shipment_id |
Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
tracking_id |
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 |
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 |
Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS, etc. |
shipped_time |
Optional. The time when the shipment was shipped. Include the year and timezone string, if available. |
earliest_delivery_promise_time |
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 |
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 |
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 |
Required. The status of the shipment. |
origin_postal_code |
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 |
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. |