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 Enum: "address_validate" "shipping" "discount" "inventory" "tax" The Checkout functionality that is overridden by this API override. |
| url required | string The destination URL at which a request will be made when functionality relating to this |
| shared_secret required | string [ 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": "address_validate",
- "url": "string",
- "shared_secret": "stringst"
}Response samples
- 200
- 422
{- "data": {
- "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": [
- {
- "id": "1",
- "override_type": "discount",
- "created_at": "2021-11-17 21:03:36",
- "updated_at": "2021-11-17 21:03:36"
}, - {
- "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. |
| 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 | string Enum: "address_validate" "shipping" "discount" "inventory" "tax" The |
| url | string The destination |
| shared_secret | string [ 8 .. 255 ] characters The string Bold uses along with the current date to create a signature for each override request. |
Responses
Request samples
- Payload
{- "override_type": "address_validate",
- "url": "string",
- "shared_secret": "stringst"
}Response samples
- 200
- 422
{- "data": {
- "id": "1",
- "override_type": "tax",
- "created_at": "2021-11-17 21:03:36",
- "updated_at": "2021-11-17 21:03:36"
}
}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. |
| 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": { }
}