Method: orders.updatelineitemshippingdetails

Updates ship by and delivery by dates for a line item.

HTTP request

POST https://www.googleapis.com/content/v2/{merchantId}/orders/{orderId}/updateLineItemShippingDetails

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 OrdersUpdateLineItemShippingDetailsRequest.

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#ordersUpdateLineItemShippingDetailsResponse"

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrdersUpdateLineItemShippingDetailsRequest

JSON representation
{
  "operationId": string,
  "lineItemId": string,
  "productId": string,
  "shipByDate": string,
  "deliverByDate": string
}
Fields
operationId

string

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

lineItemId

string

The ID of the line item to set metadata. Either lineItemId or productId is required.

productId

string

The ID of the product to set metadata. This is the REST ID used in the products service. Either lineItemId or productId is required.

shipByDate

string

Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated.

Provided date should be within 1 year timeframe and can not be a date in the past.

deliverByDate

string

Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated.

Provided date should be within 1 year timeframe and can not be a date in the past.