Thanks for being patient while we implement your feedback to improve the developer experience.

Get Consignments

GET /stores/{store_hash}/v2/orders/{order_id}/consignments

Request

Get all consignments for an order.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • order_id in path - string - required
  • store_hash in path - string - required
  • store_hash in path - string - required
  • order_id in path - integer - required

    ID of the order.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/stores/[store_hash]/v2/orders/[order_id]/consignments' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

object | application/json

  • pickups    array[object]

    Pickup consignments.

  • shipping    array[object]

    Shipping consignments.

  • downloads    array[object]

    Digital consignments for products that are downloaded.

  • email    object

    Email consignments for gift certificates.

Pickup Consignments

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

Get Consignment Shipping Quotes

GET /stores/{store_hash}/v2/orders/{order_id}/consignments/shipping/{shipping_consignment_id}/shipping_quotes

Request

Get all shipping quotes persisted on an order for a shipping consignment. This is a read-only endpoint whose response depends on the shipping quote. You can only generate a shipping quote using the storefront at this time. Orders that are created in the control panel, or using the API, return a 204 status response since you can't generate a shipping quote during that process.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • store_hash in path - string - required
  • order_id in path - integer - required

    ID of the order.

  • shipping_consignment_id in path - integer - required

    Shipping consignment ID.

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/stores/[store_hash]/v2/orders/[order_id]/consignments/shipping/[shipping_consignment_id]/shipping_quotes' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

object | application/json

  • id    string

    ID of the shipping quote.

    Example: 24

  • uuid    string

    UUID of the shipping quote.

    Example: a72acc8d-504b-4a40-8534-7c54d997ed59

  • timestamp    string

    Time the order was created in RFC 2822 format.

  • shipping_provider_id    string

    ID of the shipping provider.

    Example: bcstatic

  • shipping_provider_quote    array[]

    This can vary based on the shipping provider. Manual shipping methods such as fixed will return an empty array. Shipping providers such as UPS will return an object with the shipping information. Since the shipping quote is tied to a shipping address only one quote will return in the response.

  • provider_code    string

    Code of the shipping provider.

    Example: shipping_byweight

  • carrier_code    string

    Code of the shipping carrier.

  • rate_code    string

    Type of delivery. This can vary based on shipping quote.

  • rate_id    string

    This can vary based on shipping quote.

  • method_id    integer

    Shipping method ID

Fixed Shipping

{
  "id": "42",
  "uuid": "7c65e0a0-cf46-4438-934e-c7b4edb31e18",
  "timestamp": "Fri, 24 Jun 2022 01:45:27 +0000",
  "shipping_provider_id": "bcstatic",
  "shipping_provider_quote": [],
  "provider_code": "peritem",
  "carrier_code": "",
  "rate_code": "",
  "rate_id": "",
  "method_id": 2
}

Fedex

{
  "id": "43",
  "uuid": "551404b9-beeb-4e49-922b-3b8d85002863",
  "timestamp": "Fri, 24 Jun 2022 03:52:03 +0000",
  "shipping_provider_id": "bcrealtime",
  "shipping_provider_quote": {
    "rate": {
      "value": "107.32",
      "unit": "USD"
    },
    "transitTime": "1",
    "name": "Priority Overnight",
    "signatureConfirmationFee": {},
    "carrierName": "",
    "carrierCode": {},
    "code": {},
    "deliveryMessage": "",
    "labelSizes": [],
    "insuredMailFee": {},
    "dates": [],
    "rateId": {},
    "description": "",
    "additionalInfo": {}
  },
  "provider_code": "fedex",
  "carrier_code": "",
  "rate_code": "",
  "rate_id": "",
  "method_id": 5
}