- HTTP request
- Path parameters
- Request body
- Response body
- Authorization Scopes
- OrdersUpdateShipmentRequest
- Try it!
Updates a shipment's status, carrier, and/or tracking ID.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2/{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.
|
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 } |
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.
|
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 |