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 customers associated with a given store. Use these endpoints to retrieve information about one or all customers on your store.
List Customers
List the customers for your shop
Authorizations:
path Parameters
shop_identifier required | string Path |
query Parameters
since_id | integer <int64> Query. |
updated_at_min | string |
updated_at_max | string |
search | string |
ids | string |
orderby | string |
orderdirection | string |
filter | Array of strings |
label | string |
limit | integer <int32> |
page | integer <int32> |
Responses
Response samples
- 200
- default
{- "pagination": {
- "total": 0,
- "count": 0,
- "per_page": 0,
- "current_page": 0,
- "total_pages": 0,
- "next_url": "string",
- "previous_url": "string"
}, - "customers": [
- {
- "id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_created_at": "2019-08-24T14:15:22Z",
- "addresses": [
- {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}
], - "labels": [
- {
- "id": 0,
- "customer_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
], - "default_address": {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}, - "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "tags": "string",
- "groups": [
- {
- "id": 0,
- "name": "string",
- "shop_identifier": "string",
- "platform_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
]
}
Get Customer by Platform ID
Find a customer by platform identifier (i.e. The ID of the category in the ecommerce platform)
Authorizations:
path Parameters
shop_identifier required | string |
platform_id required | string |
Responses
Response samples
- 200
- default
{- "customer": {
- "id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_created_at": "2019-08-24T14:15:22Z",
- "addresses": [
- {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}
], - "labels": [
- {
- "id": 0,
- "customer_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
], - "default_address": {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}, - "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "tags": "string",
- "groups": [
- {
- "id": 0,
- "name": "string",
- "shop_identifier": "string",
- "platform_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}
Get Customer by ID
Find a customer by ID
Authorizations:
path Parameters
shop_identifier required | string |
id required | integer <int64> |
Responses
Response samples
- 200
- default
{- "customer": {
- "id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_created_at": "2019-08-24T14:15:22Z",
- "addresses": [
- {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}
], - "labels": [
- {
- "id": 0,
- "customer_id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
], - "default_address": {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}, - "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "tags": "string",
- "groups": [
- {
- "id": 0,
- "name": "string",
- "shop_identifier": "string",
- "platform_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
}
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.
List Customer Addresses
List the customer addresses for your shop
Authorizations:
path Parameters
shop_identifier required | string |
customer_id required | integer <int64> |
Responses
Response samples
- 200
- default
{- "addresses": [
- {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}
]
}
Get Customer Address by ID
Find a customer address by ID
Authorizations:
path Parameters
shop_identifier required | string |
customer_id required | integer <int64> |
id required | integer <int64> |
Responses
Response samples
- 200
- default
{- "address": {
- "id": 0,
- "bold_customer_id": 0,
- "shop_identifier": "string",
- "platform_type": "string",
- "first_name": "string",
- "last_name": "string",
- "street_1": "string",
- "city": "string",
- "province": "string",
- "province_code": "string",
- "zip": "string",
- "country": "string",
- "country_iso2": "string",
- "address_type": "string",
- "is_default": true,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "platform_id": {
- "string_value": "string",
- "int64_value": 0
}, - "platform_customer_id": {
- "string_value": "string",
- "int64_value": 0
}, - "address_use": "string",
- "company": {
- "value": "string",
- "valid": true
}, - "street_2": {
- "value": "string",
- "valid": true
}, - "phone": {
- "value": "string",
- "valid": true
}
}
}