List Order Products

GET

https://api-b2b.bigcommerce.com/api/v3/io/orders/:bcOrderId/products

GET

/api/v3/io/orders/:bcOrderId/products

curl https://api-b2b.bigcommerce.com/api/v3/io/orders/123/products \
     -H "X-Auth-Token: <apiKey>"

{
  "code": 200,
  "data": [
    {
      "id": 12345,
      "productId": 12345,
      "createdAt": 1744735719,
      "updatedAt": 1744735734,
      "productName": "The Planter by Rustic Roots",
      "variantSku": "CER-POT-2-SL",
      "variantId": 74669,
      "productBrandName": "Rustic Roots",
      "quantity": 5,
      "options": [
        {
          "id": 129,
          "optionId": 4243,
          "productOptionId": 258,
          "orderProductId": 3773,
          "displayName": "Color",
          "displayNameCustomer": "Color",
          "displayNameMerchant": "Color",
          "displayValue": "Slate",
          "displayValueCustomer": "Slate",
          "displayValueMerchant": "Slate",
          "value": 18836,
          "type": "Multiple choice",
          "name": "Color1736973439-63261",
          "displayStyle": "Rectangle"
        }
      ]
    }
  ],
  "meta": {
    "message": "SUCCESS"
  }
}

Retrieves product details of a specific order based on the bcOrderId provided. The bcOrderId parameter must include a valid BigCommerce Order ID (not the B2B Edition order ID returned in certain Orders endpoints) for the request to be successful.

This does not include all product information, such as pricing and physical dimensions. You can retrieve this information by using the List Order Products endpoint of the BigCommerce Orders API.

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

bcOrderIdintegerRequired

The BigCommerce order ID.

Response

codeintegerOptionalDefaults to 200

HTTP Response Code

datalist of objectsOptional

metaobjectOptional

Errors

404

Not Found Error