Migrate order tracking signals management

Order tracking signals let you provide Google with your historical order tracking data for orders completed through a merchant's site. This provides buyers more precise and accurate shipping estimates.

Compared to the Content API, there are no major changes to the order tracking signals API.

We have removed fields that we have previously deprecated. These include

  • upc
  • sku
  • product_description

In addition we have added a field:

  • Parent: accounts/{account}

This means that the API now references an account instead of a merchant.

Requests

A Content API request URL like the following:

https://shoppingcontent.googleapis.com/content/v2.1/{ACCOUNT_ID}/ordertrackingsignals

The sample response from a Content API request looks like the following:

{
  "orderCreatedTime": {
    "year": 2020,
    "month": 1,
    "day": 2,
    "hours": 0,
    "minutes": 0,
    "seconds": 0,
    "timeZone": {
      "id": "America/Los_Angeles"
    }
  },
  "orderId": "123456789",
  "shippingInfo": [
    {
      "shipmentId": "1",
      "trackingId": "100",
      "carrierName": "FEDEX",
      "carrierServiceName": "GROUND",
      "shippedTime": {
        "year": 2020,
        "month": 1,
        "day": 3,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "timeZone": {
          "id": "America/Los_Angeles"
        }
      },
      "shippingStatus": "DELIVERED"
    },
    {
      "shipmentId": "2",
      "earliestDeliveryPromiseTime": {
        "year": 2020,
        "month": 1,
        "day": 4,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "timeZone": {
          "id": "America/Los_Angeles"
        }
      },
      "latestDeliveryPromiseTime": {
        "year": 2020,
        "month": 1,
        "day": 5,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "timeZone": {
          "id": "America/Los_Angeles"
        }
      },
      "actualDeliveryTime": {
        "year": 2020,
        "month": 1,
        "day": 5,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "timeZone": {
          "id": "America/Los_Angeles"
        }
      },
      "shippedTime": {
        "year": 2020,
        "month": 1,
        "day": 3,
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "timeZone": {
          "id": "America/Los_Angeles"
        }
      },
      "shippingStatus": "DELIVERED"
    }
  ],
  "lineItems": [
    {
      "lineItemId": "item1",
      "productId": "online:en:US:item1",
      "quantity": "3"
    },
    {
      "lineItemId": "item2",
      "productId": "online:en:US:item2",
      "quantity": "5"
    }
  ],
  "shipmentLineItemMapping": [
    {
      "shipmentId": "1",
      "lineItemId": "item1",
      "quantity": "1"
    },
    {
      "shipmentId": "2",
      "lineItemId": "item1",
      "quantity": "2"
    },
    {
      "shipmentId": "1",
      "lineItemId": "item2",
      "quantity": "4"
    },
    {
      "shipmentId": "2",
      "lineItemId": "item2",
      "quantity": "1"
    }
  ],
  "customerShippingFee": {
    "value": "4.5",
    "currency": "USD"
  },
  "deliveryPostalCode": "94043",
  "deliveryRegionCode": "US"
}

The following is a sample request in Merchant API:

https://merchantapi.googleapis.com/products/ordertracking/v1beta/accounts/{ACCOUNT_ID}/ordertrackingsignals

The sample response from a Merchant API request looks like the following:

{
  "orderId": "123456789",
    "shippingInfo": [
        {
            "shipmentId": "1",
            "trackingId": "100",
            "carrierName": "FEDEX",
            "carrierServiceName": "GROUND",
            "shippedTime": {
                "year": 2020,
                "month": 1,
                "day": 3,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "timeZone": {
                    "id": "America/Los_Angeles"
                }
            },
            "shippingStatus": "DELIVERED"
        },
        {
            "shipmentId": "2",
            "earliestDeliveryPromiseTime": {
                "year": 2020,
                "month": 1,
                "day": 4,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "timeZone": {
                    "id": "America/Los_Angeles"
                }
            },
            "latestDeliveryPromiseTime": {
                "year": 2020,
                "month": 1,
                "day": 5,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "timeZone": {
                    "id": "America/Los_Angeles"
                }
            },
            "actualDeliveryTime": {
                "year": 2020,
                "month": 1,
                "day": 5,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "timeZone": {
                    "id": "America/Los_Angeles"
                }
            },
            "shippedTime": {
                "year": 2020,
                "month": 1,
                "day": 3,
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "timeZone": {
                    "id": "America/Los_Angeles"
                }
            },
            "shippingStatus": "DELIVERED"
        }
    ],
  "lineItems": [
    {
      "lineItemId": "item1",
      "productId": "online:en:US:item1",
      "quantity": "3"
    },
    {
      "lineItemId": "item2",
      "productId": "online:en:US:item2",
      "quantity": "5"
    }
  ],
  "shipmentLineItemMapping": [
    {
      "shipmentId": "1",
      "lineItemId": "item1",
      "quantity": "1"
    },
    {
      "shipmentId": "2",
      "lineItemId": "item1",
      "quantity": "2"
    },
    {
      "shipmentId": "1",
      "lineItemId": "item2",
      "quantity": "4"
    },
    {
      "shipmentId": "2",
      "lineItemId": "item2",
      "quantity": "1"
    }
  ],
  "customerShippingFee": {
    "value": "4.5",
    "currency": "USD"
  },
  "deliveryPostalCode": "94043",
  "deliveryRegionCode": "US"
}