BigCommerce
Management API
Checkout Billing Address

Checkouts

Add Checkout Billing Address

POST /checkouts/{checkoutId}/billing-address

Request

Adds a billing address to an existing checkout.

Required Fields

  • email
  • country_code

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • checkoutId in path - string - required

    ID of the checkout; the same as the cart ID.

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

    The MIME type of the response body.

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

    The MIME type of the request body.

Body

object | application/json
  • first_name
    string

  • last_name
    string

  • email
    string
    required

  • company
    string

  • address1
    string

  • address2
    string

  • city
    string

  • state_or_province
    string

    Represents state or province.

  • state_or_province_code
    string

  • country_code
    string
    required

  • postal_code
    string

  • phone
    string

  • custom_fields
    array[object]

    You can retrieve custom fields from the Get Form Fields endpoint.

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Update Checkout Billing Address

PUT /checkouts/{checkoutId}/billing-address/{addressId}

Request

Updates an existing billing address on a checkout.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • checkoutId in path - string - required

    ID of the checkout; the same as the cart ID.

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

    The MIME type of the response body.

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

    The MIME type of the request body.

  • addressId in path - integer - required

Body

object | application/json
  • first_name
    string

  • last_name
    string

  • email
    string
    required

  • company
    string

  • address1
    string

  • address2
    string

  • city
    string

  • state_or_province
    string

    Represents state or province.

  • state_or_province_code
    string

  • country_code
    string
    required

  • postal_code
    string

  • phone
    string

  • custom_fields
    array[object]

    You can retrieve custom fields from the Get Form Fields endpoint.

example

Response

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?