Orders: updateshipment

Requires authorization

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

Request

HTTP request

POST https://www.googleapis.com/content/v2/merchantId/orders/orderId/updateShipment

Parameters

Parameter name Value Description
Path parameters
merchantId unsigned long The ID of the account that manages the order. This cannot be a multi-client account.
orderId string The ID of the order.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

In the request body, supply data with the following structure:

{
  "operationId": string,
  "shipmentId": string,
  "status": string,
  "carrier": string,
  "trackingId": string,
  "deliveryDate": string
}
Property name Value Description Notes
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"
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.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "content#ordersUpdateShipmentResponse",
  "executionStatus": string
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#ordersUpdateShipmentResponse".
executionStatus string The status of the execution.

Acceptable values are:
  • "duplicate"
  • "executed"

Try it!

Use the APIs Explorer below to call this method on the Sandbox environment and see the response.
Alternatively, test this on live data.

Enviar comentarios sobre…

Content API for Shopping