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

Get Order Shipping Addresses

GET /orders/{order_id}/shipping_addresses

Request

Get all shipping addresses on an order using the order_id.

Returned in the response is shipping_quotes object. Please use the Get Shipping Quotes Endpoint. Using the response will return a 204 for the shipping quote.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • page in query - number

    The page to return in the response.

  • limit in query - number

    Number of results to return.

example

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

Response

Body

array | application/json

    response

    [
  {
    "id": 132,
    "order_id": 229,
    "first_name": "Trishy",
    "last_name": "Test",
    "company": "Acme Pty Ltd",
    "street_1": "666 Sussex St",
    "street_2": "",
    "city": "San Antonio",
    "zip": "78251",
    "country": "United States",
    "country_iso2": "US",
    "state": "Texas",
    "email": "janedoe@example.com",
    "phone": "",
    "items_total": 2,
    "items_shipped": 2,
    "shipping_method": "None",
    "base_cost": "12.9900",
    "cost_ex_tax": "12.0000",
    "cost_inc_tax": "12.9900",
    "cost_tax": "0.9900",
    "cost_tax_class_id": 0,
    "base_handling_cost": "0.0000",
    "handling_cost_ex_tax": "0.0000",
    "handling_cost_inc_tax": "0.0000",
    "handling_cost_tax": "0.0000",
    "handling_cost_tax_class_id": 0,
    "shipping_zone_id": 1,
    "shipping_zone_name": "United States -1",
    "shipping_quotes": {
      "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/orders/229/shippingaddresses/132/shippingquotes",
      "resource": "/orders/229/shippingaddresses/132/shippingquotes"
    },
    "form_fields": []
  },
  {
    "id": 133,
    "order_id": 229,
    "first_name": "Jane",
    "last_name": "Doe",
    "company": "",
    "street_1": "555 Main Street",
    "street_2": "",
    "city": "Austin",
    "zip": "78751",
    "country": "United States",
    "country_iso2": "US",
    "state": "Texas",
    "email": "janedoe@example.com",
    "phone": "",
    "items_total": 0,
    "items_shipped": 0,
    "shipping_method": "None",
    "base_cost": "12.9900",
    "cost_ex_tax": "12.0000",
    "cost_inc_tax": "12.9900",
    "cost_tax": "0.9900",
    "cost_tax_class_id": 0,
    "base_handling_cost": "0.0000",
    "handling_cost_ex_tax": "0.0000",
    "handling_cost_inc_tax": "0.0000",
    "handling_cost_tax": "0.0000",
    "handling_cost_tax_class_id": 0,
    "shipping_zone_id": 1,
    "shipping_zone_name": "United States -1",
    "shipping_quotes": {
      "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/orders/229/shippingaddresses/133/shippingquotes",
      "resource": "/orders/229/shippingaddresses/133/shippingquotes"
    },
    "form_fields": []
  }
]

    Get a Shipping Address

    GET /orders/{order_id}/shipping_addresses/{id}

    Request

    Gets a shipping address associated with an order.

    Returned in the response is shipping_quotes object. Please use the Get Shipping Quotes Endpoint. Using the response will return a 204 for the shipping quote.

    Authentication

    • X-Auth-Token in header - required

    Parameters

    • store_hash in path - string
    • Accept in header with default of application/json - string - required

      The MIME type of the response body.

    • order_id in path - integer - required

      ID of the order.

    • id in path - string - required

      Shipping address ID.

    example

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

    Response

    Body

    application/json

    • id      integer

      ID of this shipping address.

      Example: 1

    • order_id      integer

      ID of the order.

      Example: 100

    • items_total      number

      The total number of items in the order.

      Example: 1

    • items_shipped      number

      The number of items that have been shipped.

      Example: 0

    • base_cost      string

      The base value of the order’s items. (Float, Float-As-String, Integer)

      Example: 5.0000

    • cost_ex_tax      string

      The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)

      Example: 0.0000

    • cost_inc_tax      string

      The value of the order’s items, including tax. (Float, Float-As-String, Integer)

      Example: 0.0000

    • cost_tax      string

      The tax amount on the order. (Float, Float-As-String, Integer)

      Example: 0.0000

    • cost_tax_class_id      integer

      The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)

      Example: 2

    • base_handling_cost      string

      The base handling charge. (Float, Float-As-String, Integer)

      Example: 0.0000

    • handling_cost_ex_tax      string

      The handling charge, excluding tax. (Float, Float-As-String, Integer)

      Example: 0.0000

    • handling_cost_inc_tax      string

      The handling charge, including tax. (Float, Float-As-String, Integer)

      Example: 0.0000

    • handling_cost_tax      string

      Example: 0.0000

    • handling_cost_tax_class_id      integer

      A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.)

      Example: 2

    • shipping_zone_id      number

      Numeric ID of the shipping zone.

      Example: 1

    • shipping_zone_name      string

      Name of the shipping zone.

      Example: United States

    • form_fields      array[object]

    • shipping_quotes      object

    • first_name      string

      Example: Jane

    • last_name      string

      Example: Doe

    • company      string

    • street_1      string

      Street address (first line).

      Example: 123 Main Street

    • street_2      string

      Street address (second line).

    • city      string

      Example: Austin

    • state      string

      Example: Texas

    • zip      string

      Zip or postal code, as a string.

      Example: 12345

    • country      string

      Example: United States

    • country_iso2      string

      2-letter ISO Alpha-2 code for the country.

      Example: US

    • phone      string

      Recipient’s telephone number.

    • email      string

      Recipient’s email address.

      Example: janedoe@example.com

    • shipping_method      string

      Text code identifying the BigCommerce shipping module selected by the customer.

      Example: Free Shipping

      response

      {
  "id": 42,
  "order_id": 140,
  "first_name": "Jane",
  "last_name": "Doe",
  "company": "",
  "street_1": "123 MainStreet",
  "street_2": "",
  "city": "Austin",
  "zip": "78751",
  "country": "United States",
  "country_iso2": "US",
  "state": "Texas",
  "email": "jane@example.com",
  "phone": "1234567890",
  "items_total": 2,
  "items_shipped": 0,
  "shipping_method": "Fixed Shipping",
  "base_cost": "5.0000",
  "cost_ex_tax": "4.0000",
  "cost_inc_tax": "4.3200",
  "cost_tax": "0.3200",
  "cost_tax_class_id": 2,
  "base_handling_cost": "0.0000",
  "handling_cost_ex_tax": "0.0000",
  "handling_cost_inc_tax": "0.0000",
  "handling_cost_tax": "0.0000",
  "handling_cost_tax_class_id": 2,
  "shipping_zone_id": 1,
  "shipping_zone_name": "United States",
  "shipping_quotes": {
    "url": "https://api.bigcommerce.com/stores/{store_hash}/v2/orders/140/shippingaddresses/42/shippingquotes",
    "resource": "/orders/140/shippingaddresses/42/shippingquotes"
  },
  "form_fields": [
    {
      "name": "Wholesale ID",
      "value": "12345566"
    }
  ]
}

      Update a Shipping Address

      PUT /orders/{order_id}/shipping_addresses/{id}

      Request

      Update a shipping address associated with an order.

      Note: Updating a shipping address will NOT trigger the recalculation of shipping cost and tax

      Authentication

      • X-Auth-Token in header - required

      Parameters

      • store_hash in path - string
      • id in path - string - required

        Shipping address ID.

      • Content-Type in header with default of application/json - string - required

        The MIME type of the request body.

      Body

      application/json

      • first_name        string

        Example: Jane

      • last_name        string

        Example: Doe

      • company        string

      • street_1        string

        Street address (first line).

        Example: 123 Main Street

      • street_2        string

        Street address (second line).

      • city        string

        Example: Austin

      • state        string

        Example: Texas

      • zip        string

        Zip or postal code, as a string.

        Example: 12345

      • country        string

        Example: United States

      • country_iso2        string

        2-letter ISO Alpha-2 code for the country.

        Example: US

      • phone        string

        Recipient’s telephone number.

      • email        string

        Recipient’s email address.

        Example: janedoe@example.com

      • shipping_method        string

        Text code identifying the BigCommerce shipping module selected by the customer.

        Example: Free Shipping

      • form_fields        array[object]

        application/json

        {
  "first_name": "first",
  "last_name": "last",
  "company": "company",
  "street_1": "street 1",
  "street_2": "street 2",
  "city": "Sydney",
  "zip": "2000",
  "country": "Australia",
  "country_iso2": "AU",
  "state": "New South Wales",
  "email": "email2@bigcommerce.com",
  "phone": "468444123"
}

        Response

        OK

        Body

        application/json

        • id          integer

          ID of this shipping address.

          Example: 1

        • order_id          integer

          ID of the order.

          Example: 100

        • items_total          number

          The total number of items in the order.

          Example: 1

        • items_shipped          number

          The number of items that have been shipped.

          Example: 0

        • base_cost          string

          The base value of the order’s items. (Float, Float-As-String, Integer)

          Example: 5.0000

        • cost_ex_tax          string

          The value of the order’s items, excluding tax. (Float, Float-As-String, Integer)

          Example: 0.0000

        • cost_inc_tax          string

          The value of the order’s items, including tax. (Float, Float-As-String, Integer)

          Example: 0.0000

        • cost_tax          string

          The tax amount on the order. (Float, Float-As-String, Integer)

          Example: 0.0000

        • cost_tax_class_id          integer

          The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.)

          Example: 2

        • base_handling_cost          string

          The base handling charge. (Float, Float-As-String, Integer)

          Example: 0.0000

        • handling_cost_ex_tax          string

          The handling charge, excluding tax. (Float, Float-As-String, Integer)

          Example: 0.0000

        • handling_cost_inc_tax          string

          The handling charge, including tax. (Float, Float-As-String, Integer)

          Example: 0.0000

        • handling_cost_tax          string

          Example: 0.0000

        • handling_cost_tax_class_id          integer

          A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. (NOTE: Value ignored if automatic tax is enabled on the store.)

          Example: 2

        • shipping_zone_id          number

          Numeric ID of the shipping zone.

          Example: 1

        • shipping_zone_name          string

          Name of the shipping zone.

          Example: United States

        • form_fields          array[object]

        • shipping_quotes          object

        • first_name          string

          Example: Jane

        • last_name          string

          Example: Doe

        • company          string

        • street_1          string

          Street address (first line).

          Example: 123 Main Street

        • street_2          string

          Street address (second line).

        • city          string

          Example: Austin

        • state          string

          Example: Texas

        • zip          string

          Zip or postal code, as a string.

          Example: 12345

        • country          string

          Example: United States

        • country_iso2          string

          2-letter ISO Alpha-2 code for the country.

          Example: US

        • phone          string

          Recipient’s telephone number.

        • email          string

          Recipient’s email address.

          Example: janedoe@example.com

        • shipping_method          string

          Text code identifying the BigCommerce shipping module selected by the customer.

          Example: Free Shipping

          response

          {
  "id": 1,
  "order_id": 100,
  "first_name": "first",
  "last_name": "last",
  "company": "company",
  "street_1": "street 1",
  "street_2": "street 2",
  "city": "Sydney",
  "zip": "2000",
  "country": "Australia",
  "country_iso2": "AU",
  "state": "New South Wales",
  "email": "email@bigcommerce.com",
  "phone": "phone",
  "items_total": 1,
  "items_shipped": 0,
  "shipping_method": "Flat Rate",
  "base_cost": "15.0000",
  "cost_ex_tax": "15.0000",
  "cost_inc_tax": "15.0000",
  "cost_tax": "0.0000",
  "cost_tax_class_id": 2,
  "base_handling_cost": "0.0000",
  "handling_cost_ex_tax": "0.0000",
  "handling_cost_inc_tax": "0.0000",
  "handling_cost_tax": "0.0000",
  "handling_cost_tax_class_id": 2,
  "shipping_zone_id": 1,
  "shipping_zone_name": "United States",
  "shipping_quotes": {
    "url": "https://api-proxy.service.bcdev/stores/17hoqh4ddx/v2/orders/100/shipping_addresses/1/shipping_quotes",
    "resource": "/orders/100/shipping_addresses/1/shipping_quotes"
  },
  "form_fields": []
}