List Consignments

GET

https://api.bigcommerce.com/stores/:store_hash/v2/orders/:order_id/consignments

GET

/stores/:store_hash/v2/orders/:order_id/consignments

curl https://api.bigcommerce.com/stores/store_hash/v2/orders/1/consignments \
     -H "X-Auth-Token: <apiKey>"

{
  "pickups": [
    {
      "collection_instructions": "Bring your ID",
      "collection_time_description": "9am - 6pm",
      "id": 99,
      "line_items": [
        {
          "resource": "/orders/129/products/12",
          "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/orders/129/products/12"
        }
      ],
      "location": {
        "address_line_1": "123 Main Street",
        "address_line_2": "Suite 101",
        "city": "Austin",
        "code": "LOCATION-1",
        "country_alpha2": "US",
        "email": "location1@example.com",
        "id": 1,
        "name": "Location 1",
        "phone": "+1 111-111-1111",
        "postal_code": "78726",
        "state": "Texas"
      },
      "pickup_method_display_name": "Pick Up",
      "pickup_method_id": 1
    }
  ]
}

Get all consignments for an order.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Orders	modify	`store_v2_orders`
Orders	read-only	`store_v2_orders_read_only`

Authentication header

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

Path parameters

order_idintegerRequired

ID of the order.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

includelist of enumsOptional

consignments.line_items - include the response returned from the request to the /orders/{order_id}/products endpoint in consignments.

Allowed values:

Response

pickupslist of objectsOptional

Pickup consignments.

shippinglist of objectsOptional

Shipping consignments.

downloadslist of objectsOptional

Digital consignments for products that are downloaded.

emailobjectOptional

Email consignments for gift certificates.

Errors

404

Not Found Error