Package google.shopping.merchant.ordertracking.v1beta

Index

• OrderTrackingSignalsService (interface)
• CreateOrderTrackingSignalRequest (message)
• OrderTrackingSignal (message)
• OrderTrackingSignal.LineItemDetails (message)
• OrderTrackingSignal.ShipmentLineItemMapping (message)
• OrderTrackingSignal.ShippingInfo (message)
• OrderTrackingSignal.ShippingInfo.ShippingState (enum)

OrderTrackingSignalsService

Service to serve order tracking signals public API.

CreateOrderTrackingSignal
rpc CreateOrderTrackingSignal(CreateOrderTrackingSignalRequest) returns (OrderTrackingSignal) Creates new order tracking signal. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

CreateOrderTrackingSignalRequest

Signals only can be created but not updated. Businesses need to call this API only when the order is completely shipped. Creates new order signal.

Fields
parent	string Required. The account of the business for which the order signal is created. Format: accounts/{account}
order_tracking_signal_id	string Output only. The ID that uniquely identifies this order tracking signal.
order_tracking_signal	OrderTrackingSignal Required. The order signal to be created.

OrderTrackingSignal

Represents a business trade from which signals are extracted, such as shipping.

Fields
order_tracking_signal_id	int64 Output only. The ID that uniquely identifies this order tracking signal.
merchant_id	int64 Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see Submitting Order Tracking Signals.
order_created_time	DateTime Required. The time when the order was created on the businesses side. Include the year and timezone string, if available.
order_id	string Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.
shipping_info[]	ShippingInfo Required. The shipping information for the order.
line_items[]	LineItemDetails Required. Information about line items in the order.
shipment_line_item_mapping[]	ShipmentLineItemMapping Optional. The mapping of the line items to the shipment information.
delivery_postal_code	string Optional. The delivery postal code, as a continuous string without spaces or dashes, for example "95016". This field will be anonymized in returned OrderTrackingSignal creation response.
delivery_region_code	string Optional. The CLDR territory code for the shipping destination.
customer_shipping_fee	Price Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping.

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.
gtin	string Optional. The Global Trade Item Number.
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.