- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- OrdersUpdateShipmentRequest
- OrdersCustomBatchRequestEntryUpdateShipmentScheduledDeliveryDetails
- Try it!
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 |
The ID of the account that manages the order. This cannot be a multi-client account. |
orderId |
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 |
The status of the execution. Acceptable values are:
|
kind |
Identifies what kind of resource this is. Value: the fixed string " |
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 ( |
Fields | |
---|---|
operationId |
The ID of the operation. Unique across all operations for a given order. |
shipmentId |
The ID of the shipment. |
status |
New status for the shipment. Not updated if missing. Acceptable values are:
|
carrier |
The carrier handling the shipment. Not updated if missing. See |
trackingId |
The tracking ID for the shipment. Not updated if missing. |
deliveryDate |
Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if |
readyPickupDate |
Date on which the shipment has been ready for pickup, in ISO 8601 format. Optional and can be provided only if |
undeliveredDate |
Date on which the shipment has been undeliverable, in ISO 8601 format. Optional and can be provided only if |
lastPickupDate |
Date after which the pickup will expire, in ISO 8601 format. Required only when order is buy-online-pickup-in-store(BOPIS) and |
scheduledDeliveryDetails |
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 |
The date a shipment is scheduled for delivery, in ISO 8601 format. |
carrierPhoneNumber |
The phone number of the carrier fulfilling the delivery. The phone number should be formatted as the international notation in |