BigCommerce
Management API
Order Shipping Addresses

Orders V2

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

Response

Body

array | application/json

    response

    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

    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

      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

        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

          Did you find what you were looking for?