Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

Method: orders.updateshipment

Updates a shipment's status, carrier, and/or tracking ID.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/orders/{orderId}/updateShipment

Path parameters

Parameters
merchantId

string

The ID of the account that manages the order. This cannot be a multi-client account.

orderId

string

The ID of the order.

Request body

The request body contains an instance of OrdersUpdateShipmentRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "executionStatus": string,
  "kind": string
}
Fields
executionStatus

string

The status of the execution.

Acceptable values are:

  • "duplicate"
  • "executed"

kind

string

Identifies what kind of resource this is. Value: the fixed string

"content#ordersUpdateShipmentResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

OrdersUpdateShipmentRequest

JSON representation
{
  "operationId": string,
  "shipmentId": string,
  "status": string,
  "carrier": string,
  "trackingId": string,
  "deliveryDate": string,
  "readyPickupDate": string,
  "undeliveredDate": string,
  "lastPickupDate": string,
  "scheduledDeliveryDetails": {
    object (OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails)
  }
}
Fields
operationId

string

The ID of the operation. Unique across all operations for a given order.

shipmentId

string

The ID of the shipment.

status

string

New status for the shipment. Not updated if missing.

Acceptable values are:

  • "delivered"
  • "undeliverable"
  • "readyForPickup"

carrier

string

The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values.

trackingId

string

The tracking ID for the shipment. Not updated if missing.

deliveryDate

string

Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered.

readyPickupDate

string

Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if status is ready for pickup.

undeliveredDate

string

Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if status is undeliverable.

lastPickupDate

string

Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and status is ready for pickup.

scheduledDeliveryDetails

object (OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails)

Delivery details of the shipment if scheduling is needed.

OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails

ScheduledDeliveryDetails used to update the scheduled delivery order.

JSON representation
{
  "scheduledDate": string,
  "carrierPhoneNumber": string
}
Fields
scheduledDate

string

The date a shipment is scheduled for delivery, in ISO 8601 format.

carrierPhoneNumber

string

The phone number of the carrier fulfilling the delivery. The phone number should be formatted as the international notation in