Orders: shiplineitems

Note: Requires authorization.

Marks line item(s) as shipped. Try it now.

Request

HTTP request

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

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:

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

Request body

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

{
  "operationId": string,
  "lineItems": [
    {
      "lineItemId": string,
      "productId": string,
      "quantity": unsigned integer
    }
  ],
  "shipmentGroupId": string,
  "shipmentInfos": [
    {
      "shipmentId": string,
      "carrier": string,
      "trackingId": string
    }
  ]
}

Property name	Value	Description	Notes
operationId	string	The ID of the operation. Unique across all operations for a given order.
lineItems[]	list	Line items to ship.
lineItems[].lineItemId	string	The ID of the line item that is shipped. Either lineItemId or productId is required.
lineItems[].productId	string	The ID of the product to ship. This is the REST ID used in the products service. Either lineItemId or productId is required.
lineItems[].quantity	unsigned integer	The quantity that is shipped.
shipmentGroupId	string	ID of the shipment group. Required for orders that use the orderinvoices service.
shipmentInfos[]	list	Shipment information. This field is repeated because a single line item can be shipped in several packages (and have several tracking IDs).
shipmentInfos[].shipmentId	string	The ID of the shipment. This is assigned by the merchant and is unique to each shipment.
shipmentInfos[].carrier	string	The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values.
shipmentInfos[].trackingId	string	The tracking ID for the shipment.

Response

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

{
  "kind": "content#ordersShipLineItemsResponse",
  "executionStatus": string
}

Property name	Value	Description	Notes
kind	string	Identifies what kind of resource this is. Value: the fixed string "content#ordersShipLineItemsResponse".
executionStatus	string	The status of the execution. Acceptable values are: "duplicate" "executed"