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 Scopes:
|
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 customers associated with a given store. Use these endpoints to retrieve information about one or all customers on your store.
Get Customer by ID
Retrieves a customer by the Bold-generated ID.
Authorizations:
read_customers
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint. |
id required | integer <int64> Example: 82435920 A unique identifier for the customer, generated by Bold. |
Responses
Response samples
- 200
- default
{- "customer": {
- "tags": "member, 2021",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "platform_created_at": "2021-11-04T19:09:52Z",
- "id": 142329453,
- "platform_type": "bigcommerce",
- "last_name": "Doe",
- "first_name": "John",
- "labels": [
- {
- "id": 1,
- "customer_id": 82435920147,
- "name": "loyal_cust",
- "created_at": "2021-11-04T19:09:55Z",
- "updated_at": "2021-11-04T19:09:55Z",
- "deleted_at": null
}
], - "groups": [
- {
- "id": 1,
- "name": "active_sub",
- "description": "The customer is a subscriber to a product on this store via Bold Subscriptions",
- "shop_identifier": "zp3oafdor9",
- "platform_id": "group_1_plat",
- "created_at": "2021-08-01T20:11:31Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": null
}
], - "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "platform_id": "1",
- "addresses": [
- {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
], - "created_at": "2021-11-04T19:09:52Z",
- "default_address": {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
}
}
Get Customer by Platform ID
Retrieves a customer by the platform-generated customer ID.
Authorizations:
read_customers
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint. |
platform_id required | string Example: 2 A unique identifier for the customer, generated by the platform. |
Responses
Response samples
- 200
- default
{- "customer": {
- "tags": "member, 2021",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "platform_created_at": "2021-11-04T19:09:52Z",
- "id": 142329453,
- "platform_type": "bigcommerce",
- "last_name": "Doe",
- "first_name": "John",
- "labels": [
- {
- "id": 1,
- "customer_id": 82435920147,
- "name": "loyal_cust",
- "created_at": "2021-11-04T19:09:55Z",
- "updated_at": "2021-11-04T19:09:55Z",
- "deleted_at": null
}
], - "groups": [
- {
- "id": 1,
- "name": "active_sub",
- "description": "The customer is a subscriber to a product on this store via Bold Subscriptions",
- "shop_identifier": "zp3oafdor9",
- "platform_id": "group_1_plat",
- "created_at": "2021-08-01T20:11:31Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": null
}
], - "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "platform_id": "1",
- "addresses": [
- {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
], - "created_at": "2021-11-04T19:09:52Z",
- "default_address": {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
}
}
List Customers
Lists the customers that have placed orders on the store.
All query parameters must be URL-encoded. For more information about searching, refer to Query & Pagination.
Authorizations:
read_customers
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint. |
query Parameters
since_id | integer <int64> Example: since_id=2459023599 Specifies results that fall after the given ID. |
updated_at_min | string <date-time> Example: updated_at_min=2020-01-01T00:00:00Z The earliest date (in RFC3339 format) that the customer was updated. |
updated_at_max | string <date-time> Example: updated_at_max=2022-01-01T00:00:00Z The latest date (in RFC3339 format) that the customer was updated. |
search | string Example: search=%27bob%20dylan%27 A search term used to perform a fuzzy search across the customer's |
ids | string Example: ids=142329453,23490134,40245842 A comma-separated list of customer IDs. |
orderby | string Example: orderby=first_name The method of ordering the returned results. Must be paired with the |
orderdirection | string Example: orderdirection=asc The direction of ordering returned results. Must be paired with the |
filter | Array of strings Example: filter=eq(id:11) The filtering mechanism to apply to the query. For more information, refer to Query & Pagination. |
label | string Example: label=loyal_cust The label assigned to the customer. |
limit | integer <int32> Example: limit=50 The number of results per page. |
page | integer <int32> Example: page=2 The page of results to return. |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 143,
- "count": 143,
- "per_page": 50,
- "current_page": 2,
- "total_pages": 3,
}, - "customers": [
- {
- "tags": "member, 2021",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "platform_created_at": "2021-11-04T19:09:52Z",
- "id": 142329453,
- "platform_type": "bigcommerce",
- "last_name": "Doe",
- "first_name": "John",
- "labels": [
- {
- "id": 1,
- "customer_id": 82435920147,
- "name": "loyal_cust",
- "created_at": "2021-11-04T19:09:55Z",
- "updated_at": "2021-11-04T19:09:55Z",
- "deleted_at": null
}
], - "groups": [
- {
- "id": 1,
- "name": "active_sub",
- "description": "The customer is a subscriber to a product on this store via Bold Subscriptions",
- "shop_identifier": "zp3oafdor9",
- "platform_id": "group_1_plat",
- "created_at": "2021-08-01T20:11:31Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": null
}
], - "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "platform_id": "1",
- "addresses": [
- {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
], - "created_at": "2021-11-04T19:09:52Z",
- "default_address": {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
}
]
}
Validate Customer JWT
Validates a customer JWT issued by the Bold platform. The JWT is used to make calls to the Checkout Frontend API.
Authorizations:
read_customers
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint. |
platform_id required | string Example: 2 A unique identifier for the customer, generated by the platform. |
query Parameters
jwt | string Example: jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c The JSON Web Token (JWT) generated during the initialization of the order. |
Responses
Response samples
- 200
- 400
- default
{ }
Contains information about the shipping and billing addresses associated with a given store. Use these endpoints to retrieve information about one or all customer addresses on your store.
Get Customer Address by ID
Retrieves a customer address by the customer ID and the address ID.
Authorizations:
read_customers
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint. |
customer_id required | integer <int64> Example: 82435920147 A unique identifier for the customer, generated by Bold. |
id required | integer <int64> Example: 90235719 A unique identifier for the address, generated by Bold. |
Responses
Response samples
- 200
- default
{- "address": {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
}
List Customer Addresses
Lists all customer addresses for your store. For more information about searching, refer to Query & Pagination.
Authorizations:
read_customers
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint. |
customer_id required | integer <int64> Example: 82435920147 A unique identifier for the customer, generated by Bold. |
Responses
Response samples
- 200
- default
{- "addresses": [
- {
- "city": "Winnipeg",
- "province": "Manitoba",
- "province_code": "MB",
- "country": "Canada",
- "created_at": "2021-11-04T19:09:52Z",
- "zip": "R3L0L6",
- "address_type": "residential",
- "platform_customer_id": "1",
- "deleted_at": null,
- "address_use": "shipping",
- "company": "Acme Inc.",
- "street_2": "Suite 200",
- "platform_id": "address1234",
- "shop_identifier": "zp3oafdor9",
- "platform_type": "bigcommerce",
- "first_name": "John",
- "address_source": "platform",
- "last_name": "Doe",
- "updated_at": "2021-11-04T19:09:52Z",
- "phone": "2041438851",
- "is_default": true,
- "bold_customer_id": 1423294,
- "country_iso2": "CA",
- "street_1": "50 Fultz Blvd",
- "id": 90235719
}
]
}