OAuthToken
Authenticates an API request from a public integration. Generate this token in the Developer Dashboard. Refer to Build Public Integrations for more information.
Security Scheme Type | OAuth2 |
---|---|
authorizationCode OAuth Flow | Authorization URL: https://apps.boldapps.net/accounts/dashboard/authorize Token URL: https://api.boldcommerce.com/auth/oauth2/token |
APIAccessToken
Authenticates an API request from a private integration. Generate this token in the Bold Account Center. Refer to the Quick Start for more information.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API Access Token |
Contains information about the API overrides on a given store, such as the override type, redirect URL, and shared secret. Use these endpoints to manipulate overrides for a store.
Create API Override
Creates an API override for a given store. The API override is used to customize base functionality. Store level API overrides will apply to all orders, but per-order overrides may take priority. For more information, refer to API Overrides.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
override_type required | string (OverrideType) Enum: "address_validate" "shipping" "discount" "inventory" "tax" The Checkout functionality that is overridden by this API override. |
url required | string (OverrideURL) The destination URL at which a request will be made when functionality relating to this |
shared_secret required | string (OverrideSharedSecret) [ 8 .. 255 ] characters Your shared secret, a random string of sufficient length. Bold uses this string and the current date to create a signature for each override request. |
Responses
Request samples
- Payload
{- "override_type": "discount",
- "shared_secret": "aq9834g4aqkdwa0"
}
Response samples
- 200
- 422
{- "data": {
- "public_id": "1",
- "override_type": "discount",
- "created_at": "2021-11-17 21:03:36",
- "updated_at": "2021-11-17 21:03:36"
}
}
List API Overrides
Retrieves a list of registered API overrides for a given store.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
{- "data": [
- {
- "public_id": "1",
- "override_type": "discount",
- "created_at": "2021-11-17 21:03:36",
- "updated_at": "2021-11-17 21:03:36"
}, - {
- "public_id": "2",
- "override_type": "shipping",
- "created_at": "2021-11-17 21:03:36",
- "updated_at": "2021-11-17 21:03:36"
}
]
}
Update API Override
Updates the given override. Enables the caller to update the url
property, the override_type
property, or both, for a given API override. A store can have more than one API override of the same type.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
public_id required | string The identifier for the affected API override. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
override_type required | string (OverrideType) Enum: "address_validate" "shipping" "discount" "inventory" "tax" The Checkout functionality that is overridden by this API override. |
url required | string (OverrideURL) The destination URL at which a request will be made when functionality relating to this |
shared_secret required | string (OverrideSharedSecret) [ 8 .. 255 ] characters Your shared secret, a random string of sufficient length. Bold uses this string and the current date to create a signature for each override request. |
Responses
Request samples
- Payload
{- "override_type": "discount",
- "shared_secret": "aq9834g4aqkdwa0"
}
Response samples
- 200
- 422
{- "data": {
- "public_id": "1",
- "override_type": "discount",
- "created_at": "2021-11-17 21:03:36",
- "updated_at": "2021-11-20 215:09:22"
}
}
Delete API Override
Delete an API override from the given store.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
public_id required | string The identifier for the affected API override. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 422
{- "data": { }
}
Contains information about an external payment gateway that can be integrated into a store's checkout experience. Use these endpoints to manipulate the external payment gateways for a store.
Create External Payment Gateway
Adds an external payment gateway to a store.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
name required | string The name of the external payment gateway resource. |
base_url required | string The base URL that Checkout calls when performing payment operations. |
iframe_url | string or null The URL to be embedded into the payment iframe. |
target_div | string or null The identifier of the div within which you want to render the payment iframe. |
api_token | string or null An API token obtained from the external payment gateway. This token must be included on authentication headers when making requests to the external payment gateway. |
partial_capture required | boolean If true, the external payment gateway supports partial payment captures. |
additional_order_details required | boolean If true, additional metadata can be included on payments added to orders. |
provider_id required | string The identifier that the external payment gateway can use to associate a request to a particular customer. |
currency required | string 3 characters The currency supported by the external payment gateway, in ISO-4217 format. |
Responses
Request samples
- Payload
{- "name": "External Payment Gateway",
- "base_url": "www.example.com/payments",
- "iframe_url": "www.example.com/gateway",
- "target_div": "payment-1",
- "api_token": "XjqnSQWYAZXt",
- "partial_capture": true,
- "additional_order_details": true,
- "provider_id": "8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228",
- "currency": "CAD"
}
Response samples
- 200
- 422
{- "data": {
- "external_payment_gateway": {
- "public_id": "VfYRxzOjRkwG6B2xWbxhPQ",
- "shop_id": 42,
- "name": "External Payment Gateway",
- "base_url": "www.example.com/payments",
- "iframe_url": "www.example.com/gateway",
- "target_div": "payment-1",
- "api_token": "XjqnSQWYAZXt",
- "partial_capture": true,
- "additional_order_details": true,
- "provider_id": "8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228",
- "currency": "CAD"
}
}
}
List External Payment Gateways
Lists external payment gateways for a given store.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
{- "data": {
- "external_payment_gateways": [
- {
- "public_id": "SqCAft3jGmwDVK8aQbhi2R",
- "shop_id": 42,
- "name": "First External Payment Gateway",
- "base_url": "www.example-1.com/payments",
- "iframe_url": "www.example-1.com/gateway",
- "target_div": "first-payment-1",
- "api_token": "XjqnSQWYAZXt",
- "partial_capture": true,
- "additional_order_details": true,
- "provider_id": "5dgg27kce-2jd7-1h8v-j2f5-xsgn2di9s764",
- "currency": "CAD"
}, - {
- "public_id": "VfYRxzOjRkwG6B2xWbxhPQ",
- "shop_id": 42,
- "name": "Second External Payment Gateway",
- "base_url": "www.example-2.com/payments",
- "iframe_url": "www.example-2.com/gateway",
- "target_div": "second-payment-1",
- "api_token": "PjqnSQWYAZXz",
- "partial_capture": true,
- "additional_order_details": true,
- "provider_id": "8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228",
- "currency": "CAD"
}
]
}
}
Update External Payment Gateway
Updates an external payment gateway on a store.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
public_gateway_id required | string The public identifier that Bold Checkout generates when a payment gateway is added to a store. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
name required | string The name of the external payment gateway resource. |
base_url required | string The base URL that Checkout calls when performing payment operations. |
iframe_url | string or null The URL to be embedded into the payment iframe. |
target_div | string or null The identifier of the div within which you want to render the payment iframe. |
api_token | string or null An API token obtained from the external payment gateway. This token must be included on authentication headers when making requests to the external payment gateway. |
partial_capture required | boolean If true, the external payment gateway supports partial payment captures. |
additional_order_details required | boolean If true, additional metadata can be included on payments added to orders. |
provider_id required | string The identifier that the external payment gateway can use to associate a request to a particular customer. |
currency required | string 3 characters The currency supported by the external payment gateway, in ISO-4217 format. |
Responses
Request samples
- Payload
{- "name": "External Payment Gateway",
- "base_url": "www.example.com/payments",
- "iframe_url": "www.example.com/gateway",
- "target_div": "payment-1",
- "api_token": "XjqnSQWYAZXt",
- "partial_capture": true,
- "additional_order_details": true,
- "provider_id": "8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228",
- "currency": "CAD"
}
Response samples
- 200
- 422
{- "data": {
- "external_payment_gateway": {
- "public_id": "VfYRxzOjRkwG6B2xWbxhPQ",
- "shop_id": 42,
- "name": "External Payment Gateway",
- "base_url": "www.example.com/payments",
- "iframe_url": "www.example.com/gateway",
- "target_div": "payment-1",
- "api_token": "XjqnSQWYAZXt",
- "partial_capture": true,
- "additional_order_details": true,
- "provider_id": "8ad85ccf-7fd6-4f4b-a1a2-dff42fb3e228",
- "currency": "CAD"
}
}
}
Delete External Payment Gateway
Removes an external payment gateway from a store.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
public_gateway_id required | string The public identifier that Bold Checkout generates when a payment gateway is added to a store. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 422
{- "data": { }
}
Contains information about the Remote State Authority on a given store, such as the url and shared secret. Use these endpoints to manipulate configuration details for the Remote State Authority for a store. Refer to Create a Checkout Remote State Authority for more information.
Connect Remote State Authority
Connects Remote State Authority to a given shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
url required | string The destination URL to which a request will be made when order state changes occur. |
shared_secret required | string [ 8 .. 255 ] characters Your shared secret, which can be any string you choose. Bold uses this string and the current date to create a signature for each request. |
Responses
Request samples
- Payload
{- "shared_secret": "d5210fa5563dd4f5b06f00d0"
}
Response samples
- 200
- 422
{
}
Update Remote State Authority Connection
Updates connection to a Remote State Authority for a given shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
url | string The destination URL to which a request will be made when order state changes occur. |
shared_secret | string [ 8 .. 255 ] characters Your shared secret, which can be any string you choose. Bold uses this string and the current date to create a signature for each request. |
Responses
Request samples
- Payload
{- "shared_secret": "d5210fa5563dd4f5b06f00d0"
}
Response samples
- 200
- 422
{
}
Get Remote State Authority
Gets Remote State Authority connection details for a given shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
{
}
Delete Remote State Authority
Removes Remote State Authority functionality for a given shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 422
{- "data": { }
}
Contains information about Gift Cards on a given store. Use this endpoint to get all data associated with a Gift Card for a store.
Get Gift Card
Gets a gift card on a given shop, specified by either the public_payment_method_id
or a combination of the card_token
and card_pin
.
For more information, refer to the Manage Gift Cards guide.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
query Parameters
required | Public Payment Method Id (object) or Card Token and Pin (object) |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 422
- 500
{- "data": {
- "gift_card": {
- "card_token": "OAVXDVRAJUGFMHEK",
- "amount": 5000,
- "balance": 2575,
- "recipient_name": "John",
- "message": "Enjoy this gift certificate from us.",
- "expiry_date": "2025-04-01",
- "customer_name": "Jane",
- "customer_email": "[email protected]"
}
}
}
Create Tax Zone Setting
Creates or updates a tax zone setting for a tax zone. There can only be one tax zone setting for a tax zone.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
tax_provider required | string Enum: "custom" "bold" "avalara" "taxjar" "vertex" "override" The tax provider for the tax zone. If you intend to use a tax override for the shop, set this value to |
Responses
Request samples
- Payload
{- "tax_provider": "override"
}
Response samples
- 200
- 422
{- "data": {
- "zone_id": 42,
- "tax_provider": "override"
}
}
Delete Tax Zone Settings
Deletes a tax zone setting for a tax zone.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 422
{- "data": { }
}
Get Tax Zone Settings
Lists all tax zone settings for a shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
{- "data": {
- "tax_zone_settings": [
- {
- "zone_id": 42,
- "tax_provider": "override"
}
]
}
}
Contains information about the warehouses for a given store. This information is required to retrieve shipping rates and calculate taxes.
Create Warehouse
Adds a warehouse to a given shop. Each warehouse must belong to an existing warehouse zone, and a zone can have only one warehouse. Refer to Create Zone.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
address required | string The street address of the warehouse. |
address2 | string or null An additional address line. |
city required | string The city of the warehouse. |
province_code | string or null The ISO-3166 two-letter state or province code of the warehouse. |
province | string or null The state or province of the warehouse. |
country_code required | string The ISO-3166 two-letter country code of the warehouse. |
country required | string The country of the warehouse. |
postal_code required | string The postal code or zip code of the warehouse. |
extended_postal_code | string or null Additional postal code data. |
Responses
Request samples
- Payload
{- "address": "123 Main St.",
- "address2": "c/o Buck Skaggstein",
- "city": "American Fork",
- "province_code": "UT",
- "province": "Utah",
- "country_code": "US",
- "country": "United States",
- "postal_code": "84003",
- "extended_postal_code": "52"
}
Response samples
- 200
- 404
- 422
{- "data": {
- "address": "123 Main St.",
- "address2": "c/o Buck Skaggstein",
- "city": "American Fork",
- "province_code": "UT",
- "province": "Utah",
- "country_code": "US",
- "country": "United States",
- "postal_code": "84003",
- "extended_postal_code": "52",
- "zone_id": 283
}
}
Update Warehouse
Updates a warehouse.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
address | string The street address of the warehouse. |
address2 | string or null An additional address line. |
city | string The city of the warehouse. |
province_code | string or null The ISO-3166 two-letter state or province code of the warehouse. |
province | string or null The state or province of the warehouse. |
country_code | string The ISO-3166 two-letter country code of the warehouse. |
country | string The country of the warehouse. |
postal_code | string The postal code or zip code of the warehouse. |
extended_postal_code | string or null Additional postal code data. |
Responses
Request samples
- Payload
{- "address": "123 Main St.",
- "address2": "c/o Buck Skaggstein",
- "city": "American Fork",
- "province_code": "UT",
- "province": "Utah",
- "country_code": "US",
- "country": "United States",
- "postal_code": "84003",
- "extended_postal_code": "52"
}
Response samples
- 200
- 404
- 422
{- "data": {
- "address": "123 Main St.",
- "address2": "c/o Buck Skaggstein",
- "city": "American Fork",
- "province_code": "UT",
- "province": "Utah",
- "country_code": "US",
- "country": "United States",
- "postal_code": "84003",
- "extended_postal_code": "52",
- "zone_id": 283
}
}
Delete Warehouse
Deletes a warehouse.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 404
{- "data": { }
}
List Warehouses
Lists all warehouses for a given shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
{- "data": {
- "warehouses": [
- {
- "address": "123 Main St.",
- "address2": "c/o Buck Skaggstein",
- "city": "American Fork",
- "province_code": "UT",
- "province": "Utah",
- "country_code": "US",
- "country": "United States",
- "postal_code": "84003",
- "extended_postal_code": "52",
- "zone_id": 283
}
]
}
}
Zones are geographic locations made up of one or more regions, which can be used to describe parameters for specific places. Zones come in three types: warehouse, tax, and shipping.
- Warehouse zones are used to define areas that are served by a single shipping origin. These are used to determine where shipping is available and sometimes how taxes are calculated.
- Tax zones are used to define areas that are served by a given tax provider.
- Shipping zones are used to define areas where particular shipping carriers and rates are available.
Tip: A default zone is used as a catch-all for regions that are not explicitly placed in a zone. Some operations in Checkout require at least one zone to be created; if you have no interest in specific regions, you can use a default zone instead.
Create Zone
Adds a warehouse, shipping, or tax zone.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
name required | string A user-friendly name for the zone. |
type required | string Enum: "shipping" "tax" "warehouse" The type of zone to create. |
default | boolean Default: false Whether this zone should be used in the absence of any other applicable zone. There may only be one default zone for each zone type. |
enabled | boolean Default: true Whether this zone can be used during Checkout. |
required | Array of objects (Regions) [ items >= 0 items ] An array of regions encompassed by this zone. |
Responses
Request samples
- Payload
{- "name": "Western Region",
- "type": "warehouse",
- "regions": [
- {
- "country_code": "CA",
- "province_code": "MB"
}, - {
- "country_code": "CA",
- "province_CODE": "SK"
}
]
}
Response samples
- 200
- 422
{- "data": {
- "id": 283,
- "name": "Western Region",
- "type": "warehouse",
- "default": false,
- "enabled": true,
- "regions": [
- {
- "country_code": "CA",
- "province_code": "MB"
}
]
}
}
List Zones
Lists all zones for a shop.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
{- "data": {
- "zones": [
- {
- "id": 283,
- "name": "Western Region",
- "type": "warehouse",
- "default": false,
- "enabled": true,
- "regions": [
- {
- "country_code": "CA",
- "province_code": "MB"
}
]
}
]
}
}
Update Zone
Updates an existing zone. Note that it is not possible to update an existing zone's type
.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Request Body schema: application/json
name | string A user-friendly name for the zone. |
default | boolean Default: false Whether this zone should be used if no other zone is applicable. There may only be one default zone for each zone type. |
enabled | boolean Default: true Whether this zone can be used during checkout. |
Array of objects (Regions) [ items >= 0 items ] An array of regions encompassed by this zone. |
Responses
Request samples
- Payload
{- "name": "Western Region",
- "default": true,
- "enabled": false,
- "regions": [
- {
- "country_code": "CA",
- "province_code": "MB"
}
]
}
Response samples
- 200
- 404
- 422
{- "data": {
- "id": 283,
- "name": "Western Region",
- "type": "warehouse",
- "default": false,
- "enabled": true,
- "regions": [
- {
- "country_code": "CA",
- "province_code": "MB"
}
]
}
}
Delete Zone
Deletes an existing zone. Any regions, tax zone settings, and warehouses associated with the zone will also be deleted.
Authorizations:
path Parameters
shop_identifier required | string The identifier of the shop, which can be retrieved by making a request to the Get Shop Info endpoint. |
zone_id required | integer The identifier Bold Checkout uses for a zone. Refer to Create Zone. |
header Parameters
Authorization required | string <Bearer-Token> Example: Bearer yroF643MyJSeVQQJDKdvsd1awWcpiEQInHNi2dZXfYoOuR4vaFUHi4pODoiEai9T Authenticates the API request. The expected token can either be generated from the "Developer Settings" page in the Account Center admin or through the OAuth authorization framework. For more information about generating an API access token, refer to the Quick Start. |
Responses
Response samples
- 200
- 422
{- "data": { }
}