List order line items

GET

https://api.mailchimp.com/3.0/ecommerce/stores/:store_id/orders/:order_id/lines

GET

/3.0/ecommerce/stores/:store_id/orders/:order_id/lines

curl https://api.mailchimp.com/3.0/ecommerce/stores/store_id/orders/order_id/lines \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "lines": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "discount": 1.1,
      "id": "string",
      "image_url": "string",
      "price": 1.1,
      "product_id": "string",
      "product_title": "string",
      "product_variant_id": "string",
      "product_variant_title": "string",
      "quantity": 1
    }
  ],
  "order_id": "string",
  "store_id": "string",
  "total_items": 1
}

Get information about an order’s line items.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

store_idstringRequired

The store id.

order_idstringRequired

The id for the order in a store.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

lineslist of objectsOptional

An array of objects, each representing an order's line item.

order_idstringOptional

The order id.

store_idstringOptional

The store id.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.