Skip to main content
API docs by Redocly

Platform Connector API Specification (1.0.0)

Download OpenAPI specification:Download

URL: https://developer-dashboard.boldcommerce.com/default/contactus Terms of Service

The Platform Connector API allows Bold to interact with your platform's customers, orders, and products.

This specification file defines the expected server behavior of the Platform Connector Server. Bold applications require the endpoints listed here to be implemented in order to function properly.

Refer to the changelog for the latest updates to this API.

Note: This specification is only for use with a Bold Platform Connector.

For more information about Platform Connectors, refer to the Overview.

Verification

Use these endpoints to verify your platform connector destination.

Verify Platform Connector Destination

Confirms that you own a given Platform Connector destination. Bold calls this endpoint on your Platform Connector when you attempt to Create or Update a destination.

Responds with a calculated X-HMAC header containing the content of the sent X-HMAC-Timestamp header encoded with the shared secret.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Responses

Response samples

Content type
application/json
{ }

Customers

Contains information about a customer, including name, contact info, and addresses. Bold calls these endpoints to manage customers on your platform.

Create Customer

Create a customer in your platform.

The request body contains a complete customer entity, you must persistently store on your platform.

A successful response contains the same customer, with its associated platform_id and timestamps populated. The platform_id is unique, because Bold applications use it to identify the customer and its fields. The returned platform_id can be used in requests to other endpoints in this API.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (createCustomerRequestData)
object (customerNew)
email
required
string <email>

The email address for the customer.

first_name
string

The first name of the customer.

last_name
string

The last name of the customer.

phone
string <phone>

The phone number for the customer.

Array of objects (addressNew)

A list of customer addresses.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

List Customers

List customers that have made a purchase from your store. Include the email parameter to retrieve a certain customer.

Returns a page of customers for your store, with limit as the maximum number of results and paginated by cursor. Return customers in ascending order of platform_id. If the request does not supply a limit (or supplies an invalid one), then use the default limit (250).

Each cursor points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no cursor is applied, return the first page of results.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

query Parameters
limit
integer <int32> [ 1 .. 250 ]
Default: 250
Example: limit=100

The maximum number of results to return per page.

cursor
string
Example: cursor=dW50ZXN0dW50ZXN0dW50ZXN0

A cursor to obtain the next page of results. Bold takes the value of the cursor directly from the next value in the response without any modifications.

email
string

An email used to filter the results.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}

Update Customer

Update a customer specified by platform_id.

Replace all fields of the customer object with the values provided in the request body. Ignore and do not update any fields omitted from the request body.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_id
required
string
Example: customer-123456

A unique identifier for the customer. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (updateCustomerRequestData)
object (customerUpdate)
Array of objects (addressNew)

A list of customer addresses.

email
string <email>

The email address for the customer.

first_name
string

The first name of the customer.

last_name
string

The last name of the customer.

phone
string <phone>

The phone number for the customer.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Customer

Delete a customer specified by platform_id. Mark the customer as deleted within the platform.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_id
required
string
Example: customer-123456

A unique identifier for the customer. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Responses

Response samples

Content type
application/json
{ }

Validate Customer JWT

Validate the JWT to determine if it is a valid token and corresponds to the provided customer. The JWT is used to authorize the frontend code to perform various actions on behalf of the customer. For more information, refer to the Initialize Order endpoint.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_id
required
string
Example: customer-123456

A unique identifier for the customer. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (customerValidateRequestData)
object (tokenInfo)
token
required
string

The token to inspect.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Addresses

A child of the Customer resource. Contains information about a billing or shipping address associated with a given customer. Bold calls these endpoints to manage addresses on your platform.

Create Address

Create an address for a customer, specified by platform_customer_id.

The request body contains a complete address entity, which you must persistently store on the platform. A successful response contains the same address, including its associated platform_id and platform_customer_id. These IDs must be unique among addresses, because Bold applications use them to identify the address for the customer. Bold can use the returned platform_id to make requests to other address endpoints in this API.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_customer_id
required
string
Example: customer-123456

Unique identifier for the customer. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (createAddressRequestData)
object (addressNew)
address_type
string

The type of the address (i.e., residential, commercial).

address_use
string
Enum: "billing" "shipping"

The usage of the address. Possible values are "billing" or "shipping".

company
string

The name of the company operating at the specified address, if applicable.

city
string

The name of the city associated with the address.

country
string

The name of the country associated with the address.

country_code
string

The country code (in ISO 3166-1 alpha-2 format) of the address.

is_default
boolean <boolean>

Indicates whether this is the default address for the customer. There can only be one default address for a customer. If this modifies any other resources, ensure the appropriate event notifications are triggered for those affected by this change.

first_name
string

The first name of the customer with the address.

last_name
string

The last name of the customer with the address.

phone
string <phone>

The phone number of the address.

postal_code
string

The postal code or zip code for the address.

province
string

The province or state for the address.

province_code
string

The province or state abbreviation for the address.

street_1
string

The primary street information for the address.

street_2
string

Any additional street information for the address.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Address

Update an address. Bold indicates the address by the platform_id and the customer by the platform_customer_id.

Replace all fields of an address object with the values provided in the request body. Ignore and do not change any fields omitted from the request body.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_customer_id
required
string
Example: customer-123456

Unique identifier for the customer. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (updateAddressRequestData)
object (addressNew)
address_type
string

The type of the address (i.e., residential, commercial).

address_use
string
Enum: "billing" "shipping"

The usage of the address. Possible values are "billing" or "shipping".

company
string

The name of the company operating at the specified address, if applicable.

city
string

The name of the city associated with the address.

country
string

The name of the country associated with the address.

country_code
string

The country code (in ISO 3166-1 alpha-2 format) of the address.

is_default
boolean <boolean>

Indicates whether this is the default address for the customer. There can only be one default address for a customer. If this modifies any other resources, ensure the appropriate event notifications are triggered for those affected by this change.

first_name
string

The first name of the customer with the address.

last_name
string

The last name of the customer with the address.

phone
string <phone>

The phone number of the address.

postal_code
string

The postal code or zip code for the address.

province
string

The province or state for the address.

province_code
string

The province or state abbreviation for the address.

street_1
string

The primary street information for the address.

street_2
string

Any additional street information for the address.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete Address

Delete an address. Bold indicates the address by the platform_id and the customer by the platform_customer_id. Mark the address as deleted on the platform.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_customer_id
required
string
Example: customer-123456

Unique identifier for the customer. Assigned by the platform.

platform_id
required
string
Example: address-123456

Unique identifier for the address. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Responses

Response samples

Content type
application/json
{ }

Orders

Contains information about an order, including addresses, line items, payments, and additional order details. Bold calls these endpoints to manage orders on your platform.

Create Order

Create an order on the platform.

The request body contains a complete order entity, which you must persistently store on your platform.

A successful response contains the same order, with its associated platform_id and timestamps populated. The platform_id is unique, because Bold applications use it to identify the order and its fields. Bold uses the returned platform_id to make requests to other endpoints in this API.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Idempotency-Key
string
Example: qaasc934qfj9aerf

Use the HTTP idempotency request header field to carry an idempotency key in order to make non-idempotent HTTP methods, such as POST or PATCH, fault-tolerant.

Request Body schema: application/json
required
object (createOrderRequestData)
object (orderRequest)
Array of objects (addressRequest)

A list of shipping addresses for the order.

object (addressRequest)

The billing address for the order.

Array of objects (lineItemRequest)

A list of line items for the order.

Array of objects (paymentRequest)

A list of payments for this order.

order_number
string

A human-readable identifier for the order.

platform_customer_id
string

A unique identifier for the customer associated to this order. Assigned by the platform.

platform_friendly_id
string

A unique identifier for the order on the platform. This field is used to identify the order on the platform and is used by the Bold Checkout Admin to link the order to the platform.

shipping_method
string

The shipping method for the order.

shipping_code
string

The shipping method code for the order. Each store defines its own shipping codes.

browser_ip
string

The browser IP under which the order was placed by the customer.

source
string

A label noting the mechanism which placed this order.

created_via
string

A label noting which app created the order (if applicable).

locale
string

The locale code of the order (either in ISO-639 language code format or in ISO/IEC-15897 regional language format).

test
boolean

Indicates whether this is a test order.

notes
string

Any internal notes about the order.

public_notes
string

Any customer-facing notes about the order.

object

Any key-value pairs of metadata relevant to the order.

shipping_subtotal
string <double>

The shipping cost for the ordered items, in the order's given currency. Calculated before taxes.

shipping_tax
string <double>

The sum of all shipping taxes for the ordered items, in the order's given currency.

Array of objects (tax)

A list of individual shipping taxes for each line item on the order.

discount
string <double>

The total amount discounted from the order, in the order's given currency. If there is no discount, set this field to "0".

Note: If discount is included in the payload, the total and total_tax values are required.

object

The list of discounts applied to the order.

subtotal
string <double>

The subtotal of the line items on the order, in the order's given currency.

Note: Calculate the subtotal before taxes and discounts (if those values are not included in the line item prices).

subtotal_tax
string <double>

The tax to be charged on all line items, in the order's given currency.

total_tax
string <double>

The total tax on the full order, in the order's given currency, including: subtotal_tax, shipping_tax, and any other special taxes pending for the order.

total
string <double>

The total order cost, in the order's given currency.

Note: This number includes taxes and is reduced by the discount.

refunded_amount
string <double>

The refunded amount of the order, if any, in the order's given currency.

currency
string

The base currency used for the order (in ISO-4217 currency code format).

order_status
string
Enum: "active" "cancelled"

The current status of the order. Indicates whether the order is active or has been cancelled.

fulfillment_status
string
Enum: "pending" "partial" "delivered" "fulfilled"

The fulfillment status of the order.

financial_status
string
Enum: "held_for_review" "disputed" "cancelled" "pending" "preauthed" "refunded" "partially_paid" "partially_refunded" "paid"

The status of payments associated with the order. This field can only be set when the order is created and cannot be changed if the order is updated.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

List Orders

List all orders made on a store.

Return a page of orders from your store, with limit as the maximum number of results and paginated by cursor. Return orders in ascending order of platform_id. If the request does not supply a limit (or supplies an invalid one), then use the default limit (250).

Each cursor points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no cursor is supplied, return the first page of results.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

query Parameters
limit
integer <int32> [ 1 .. 250 ]
Default: 250
Example: limit=100

The maximum number of results to return per page.

cursor
string
Example: cursor=dW50ZXN0dW50ZXN0dW50ZXN0

A cursor to obtain the next page of results. Bold takes the value of the cursor directly from the next value in the response without any modifications.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}

Get Order

Retrieve an order placed on your store by the specified platform_id.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_id
required
string
Example: order-123456

Unique identifier for the order. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Order

Update an order specified by platform_id.

Replace all fields of the order object with the values provided in the request body. Ignore and do not update any fields omitted from the request body.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_id
required
string
Example: order-123456

Unique identifier for the order. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (updateOrderRequestData)
object (orderUpdateRequest)
fulfillment_status
string
Enum: "pending" "partial" "delivered" "fulfilled"

The fulfillment status of each line item on the order.

financial_status
string
Enum: "held_for_review" "disputed" "cancelled" "pending" "preauthed" "refunded" "partially_paid" "partially_refunded" "paid"

The status of payments associated with the order. This field can only be set when the order is created and cannot be changed if the order is updated.

refunded_amount
string <double>

The total refunded amount, if any, applied to the order. Measured in units of the order currency.

notes
string

Any internal notes about the order.

object

A series of key-value pairs of additional metadata relevant to the order.

Array of objects (addressRequest)

List of shipping addresses for the order.

subtotal
string <double>

The subtotal of the line items on the order, in the order's given currency.

Note: Calculate the subtotal before taxes and discounts (if those values are not included in the line item prices).

subtotal_tax
string <double>

The tax to be charged on all line items, in the order's given currency.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create Payment

Create a payment associated with a given order.

The request body contains a complete order entity, which you must persistently store on your platform.

A successful response contains the same payment, with its associated platform_id and timestamps populated. The platform_id must be unique, because Bold applications use it to identify the payment and its fields. The returned platform_id can be used in requests to other endpoints in this API.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

platform_id
required
string
Example: order-123456

Unique identifier for the order. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (createPaymentRequestData)
object (paymentRequest)
Array of objects (transactionRequest)

A list of transactions for the payment. Multiple transactions can be associated with a single payment

description
string

A human-readable description of the payment.

provider
string

A label indicating the organization handling the payment and transactions.

payment_method
string

The payment method used.

currency
string

The currency used for the payment, in ISO-4217 currency code format.

amount_planned
string <double>

The amount that the payment provider plans to charge for the payment, in the payment's given currency. If the payment has been completed, this amount reflects the amount charged. This value typically matches the order total.

object

A series of key-value pairs of metadata relevant to the payment.

status
string

The status of the payment. Values are dependent on the payment provider used and should be passed through as-is.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update Payment

Update a payment associated with a specific order. Specify the payment by platform_id and the order by order_platform_id.

Replace all fields of the payment object with the values provided in the request body. Ignore and do not update any fields omitted from the request body.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

order_platform_id
required
string
Example: order-123456

Unique identifier for the order. Assigned by the platform.

platform_id
required
string
Example: payment-123456

Unique identifier for the payment. Assigned by the platform.

header Parameters
X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

Request Body schema: application/json
required
object (updatePaymentRequestData)
object (updatePaymentRequest)
Array of objects (transactionRequest)

A list of transactions for the payment.

status
string

The status of the payment. Values are dependent on the payment provider used and should be passed through as-is.

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Products

Contains information about a product, including names, descriptions, applicable options and variants, and other details. Bold calls these endpoints to retrieve information about the products on your platform.

List Products

List all products that exist in your store.

Return a page of products for your store, with limit as the maximum number of results and paginated by cursor. Return products in ascending order of platform_id. If the request does not supply a limit (or supplies an invalid one), use the default limit (250).

Each cursor points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no cursor is supplied, return the first page of results.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

query Parameters
limit
integer <int32> [ 1 .. 250 ]
Default: 250
Example: limit=100

The maximum number of results to return per page.

cursor
string
Example: cursor=dW50ZXN0dW50ZXN0dW50ZXN0

A cursor to obtain the next page of results. Bold takes the value of the cursor directly from the next value in the response without any modifications.

header Parameters
User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}

Categories

Contains information about product categories, including names, image, and platform information. Bold calls these endpoints to retrieve information about the categories on your platform.

List Categories

Lists all product categories in a given store.

Return a page of product categories for your store, with limit as the maximum number of results and paginated by cursor. Return categories in ascending order of platform_id. If the request does not supply a limit (or supplies an invalid one), use the default limit (250).

Each cursor points to a location in the dataset. Cursors can be supplied to subsequent calls for additional data in the dataset. If no cursor is supplied, return the first page of results.

Authorizations:
HMAC
path Parameters
shop_identifier
required
string
Example: zp3oafdor9

A unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.

query Parameters
limit
integer <int32> [ 1 .. 250 ]
Default: 250
Example: limit=100

The maximum number of results to return per page.

cursor
string
Example: cursor=dW50ZXN0dW50ZXN0dW50ZXN0

A cursor to obtain the next page of results. Bold takes the value of the cursor directly from the next value in the response without any modifications.

header Parameters
User-Agent
required
string
Example: Bold-API

A value to help filter traffic from Bold through any firewall system. Bold sends requests to your Platform Connector with the value Bold-API. You can adjust your firewall system to allow calls with this value to reach your Platform Connector.

X-HMAC-Timestamp
required
string <date-time>
Example: 2021-03-11T17:16:51Z

The UTC server time (in RFC 3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}