- Resource: OrderTrackingSignal
- DateTime
- TimeZone
- ShippingInfo
- ShippingState
- LineItemDetails
- ShipmentLineItemMapping
- Methods
Resource: OrderTrackingSignal
Represents a merchant trade from which signals are extracted, e.g. shipping.
JSON representation |
---|
{ "orderTrackingSignalId": string, "merchantId": string, "orderCreatedTime": { object ( |
Fields | |
---|---|
orderTrackingSignalId |
Output only. The ID that uniquely identifies this order tracking signal. |
merchantId |
The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see Submitting Order Tracking Signals. |
orderCreatedTime |
Required. The time when the order was created on the merchant side. Include the year and timezone string, if available. |
orderId |
Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response. |
shippingInfo[] |
The shipping information for the order. |
lineItems[] |
Information about line items in the order. |
shipmentLineItemMapping[] |
The mapping of the line items to the shipment information. |
customerShippingFee |
The shipping fee of the order; this value should be set to zero in the case of free shipping. |
deliveryPostalCode |
Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. "95016". This field will be anonymized in returned OrderTrackingSignal creation response. |
deliveryRegionCode |
Required. The CLDR territory code for the shipping destination. |
DateTime
Represents civil time (or occasionally physical time).
This type can represent a civil time in one of a few possible ways:
- When utcOffset is set and timeZone is unset: a civil time on a calendar day with a particular offset from UTC.
- When timeZone is set and utcOffset is unset: a civil time on a calendar day in a particular time zone.
- When neither timeZone nor utcOffset is set: a civil time on a calendar day in local time.
The date is relative to the Proleptic Gregorian Calendar.
If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively.
This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset
oneof is set. Consider using Timestamp
message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field.
This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
JSON representation |
---|
{ "year": integer, "month": integer, "day": integer, "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer, // Union field |
Fields | |
---|---|
year |
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
month |
Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. |
day |
Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. |
hours |
Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. |
seconds |
Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. |
Union field time_offset . Optional. Specifies either the UTC offset or the time zone of the DateTime. Choose carefully between them, considering that time zone data may change in the future (for example, a country modifies their DST start/end dates, and future DateTimes in the affected range had already been stored). If omitted, the DateTime is considered to be in local time. time_offset can be only one of the following: |
|
utcOffset |
UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. A duration in seconds with up to nine fractional digits, ending with ' |
timeZone |
Time zone. |
TimeZone
Represents a time zone from the IANA Time Zone Database.
JSON representation |
---|
{ "id": string, "version": string } |
Fields | |
---|---|
id |
IANA Time Zone Database time zone, e.g. "America/New_York". |
version |
Optional. IANA Time Zone Database version number, e.g. "2019a". |
ShippingInfo
The shipping information for the order.
JSON representation |
---|
{ "shipmentId": string, "trackingId": string, "carrierName": string, "carrierServiceName": string, "shippedTime": { object ( |
Fields | |
---|---|
shipmentId |
Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
trackingId |
The tracking ID of the shipment. This field is required if one of the following fields is absent: earliestDeliveryPromiseTime, latestDeliveryPromiseTime, and actualDeliveryTime. |
carrierName |
The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliestDeliveryPromiseTime, latestDeliveryPromiseTime, and actualDeliveryTime. |
carrierServiceName |
The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc. |
shippedTime |
The time when the shipment was shipped. Include the year and timezone string, if available. |
earliestDeliveryPromiseTime |
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: trackingId or carrierName. |
latestDeliveryPromiseTime |
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: trackingId or carrierName. |
actualDeliveryTime |
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: trackingId or carrierName. |
shippingStatus |
The status of the shipment. |
originPostalCode |
The origin postal code, as a continuous string without spaces or dashes, e.g. "95016". This field will be anonymized in returned OrderTrackingSignal creation response. |
originRegionCode |
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 merchant. |
SHIPPED |
All items are shipped. |
DELIVERED |
The shipment is already delivered. |
LineItemDetails
The line items of the order.
JSON representation |
---|
{ "lineItemId": string, "productId": string, "gtin": string, "mpn": string, "quantity": string, "upc": string, "sku": string, "productDescription": string, "productTitle": string, "brand": string } |
Fields | |
---|---|
lineItemId |
Required. The ID for this line item. |
productId |
Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId. |
gtin |
The Global Trade Item Number. |
mpn |
The manufacturer part number. |
quantity |
The quantity of the line item in the order. |
upc |
Universal product code for this item (deprecated: Please use GTIN instead). |
sku |
Merchant SKU for this item (deprecated). |
productDescription |
Plain text description of this product (deprecated: Please use productTitle instead). |
productTitle |
Plain text title of this product. |
brand |
Brand of the product. |
ShipmentLineItemMapping
Represents how many items are in the shipment for the given shipmentId and lineItemId.
JSON representation |
---|
{ "shipmentId": string, "lineItemId": string, "quantity": string } |
Fields | |
---|---|
shipmentId |
Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response. |
lineItemId |
Required. The line item ID. |
quantity |
The line item quantity in the shipment. |
Methods |
|
---|---|
|
Creates new order tracking signal. |