We will sunset v2 of the Content API on March 29th, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible. For more information, see Migrating to v2.1.

Method: orders.shiplineitems

Marks line item(s) as shipped.

HTTP request

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

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

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

.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

OrdersShipLineItemsRequest

JSON representation
{
  "operationId": string,
  "lineItems": [
    {
      object (OrderShipmentLineItemShipment)
    }
  ],
  "shipmentInfos": [
    {
      object (OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo)
    }
  ],
  "shipmentGroupId": string
}
Fields
operationId

string

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

lineItems[]

object (OrderShipmentLineItemShipment)

Line items to ship.

shipmentInfos[]

object (OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo)

Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).

shipmentGroupId

string

ID of the shipment group. Required for orders that use the orderinvoices service.

OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo

JSON representation
{
  "shipmentId": string,
  "carrier": string,
  "trackingId": string
}
Fields
shipmentId

string

Required. The ID of the shipment. This is assigned by the merchant and is unique to each shipment.

carrier

string

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

trackingId

string

The tracking ID for the shipment.