We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

Submitting Order Tracking Signals

Order tracking signals allow you to provide Google with your historical order tracking data for orders completed through a merchant’s site, so that we can provide buyers more precise and accurate shipping estimates. Order tracking signals also allow you to enhance your listings with free and fast shipping annotations. You can submit data both for orders completed through a merchant’s site and through Buy on Google. The data that you submit compliments the shipping configuration information that you provide as part of your Merchant Center account setup. For example, if you provide buyers with shipping estimates of 3-7 days, but your recent historical order tracking indicates that your orders typically arrive in 3 days in some regions, Google can update your listings to provide customers with a more precise estimate.

This guide explains how to use the ordertrackingsignals service to submit your historical order tracking data.

Using the ordertrackingsignals service

The ordertrackingsignals service includes a single create endpoint, which allows you to submit your historical order tracking data. Only submit data for orders that have been delivered, so that we can verify shipping times. You can submit one order per request. In the request body you can submit the following information:

  • Order information, including the order ID and the order creation time, delivery postal code, and region code
  • Shipping cost charged to the buyer (customer_shipping_fee)
  • Shipping information (shippingInfo) including the carrier, tracking, origin, destination, and shipping times for each shipment associated with the order
  • Order line item information (lineItems), including the products in the order
  • A mapping of the order line items to order shipments (shipment_line_item_mapping)
  • The merchant ID of the merchant for which you are submitting data (merchant_id). This field is optional and allows you to provide data on behalf of another merchant. If you do not provide a value for this field, the data is associated with the account that submits it.

For more information on required and optional order tracking fields, see the reference documentation for the ordertrackingsignals resource.

Example: Submitting new order tracking signals data

To submit order tracking data, make a POST request using following URL and request body:

https://shoppingcontent.googleapis.com/content/v2.1/merchantId/ordertrackingsignals
{
  “orderCreatedTime”: “2020-01-02T09:00:00+01:00”,
  “orderId”: “123456789”,
  “delivery_postal_code”: “94043”,
  “region_code”: “US”,

  “customer_shipping_fee”:
  {
    “value”: “4.5”,
    “currency”: “USD”
  },

  “shippingInfo”:
  [
    {
      “shipment_id”: “1”,
      “tracking_id”: “100”,
      “shipping_carrier_name”: “FEDEX”,
      “carrier_service_name”: “GROUND”,
      “shipped_time”: “2020-01-03T09:00:00+01:00”,
      “shipping_status”: “DELIVERED”
    },
    {
      “shipment_id”: “2”,
      “earliest_delivery_promise”: “2020-01-04T09:00:00+01:00”,
      “latest_delivery_promise”: “2020-01-05T09:00:00+01:00”,
      “actual_delivery_time”: “2020-01-05T09:00:00+01:00”,
      “shipped_time”: “2020-01-03T09:00:00+01:00”,
      “shipping_status”: “DELIVERED”
    }
  ],

  “lineItems”:
  [
    {
      “line_item_id”: “item1”,
      “product_id”: “online:en:US:item1”,
      “quantity”: 3
    },
    {
      “iine_item_id”: “item2”,
      “product_id”: “online:en:US:item2”,
      “quantity”: 5
    }
  ],

  “shipment_line_item_mapping”:
  [
    {
      “shipment_id”: “1”,
      “line_item_id”: “item1”,
      “quantity”: 1
    },
    {
      “shipment_id”: “2”,
      “line_item_id”: “item1”,
      “quantity”: 2
    },
    {
      “shipment_id”: “1”,
      “line_item_id”: “item2”,
      “quantity”: 4
    },
    {
      “shipment_id”: “2”,
      “line_item_id”: “item2”,
      “quantity”: 1
    },
  ]
}

Updating existing order tracking signals data

To modify already submitted order tracking data, submit a request that contains new data with the same orderId. For shipping estimates and fast and free badging, only the most recently submitted data for each orderId is used.