Platform Connector API Specification (1.0.0)

Download OpenAPI specification:Download

URL: https://developer.boldcommerce.com/default/contactus

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.

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

Authentication

HMAC

An HMAC signature calculated from the current shared secret (created in the Bold Account Center) and the value of the X-HMAC-Timestamp header. For more information about verifying this signature, refer to Implement Platform Connector APIs.

Security Scheme Type	API Key
Header parameter name:	X-HMAC

Verification

Operations 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.

path Parameters

shop_identifier

required

string

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 RFC3339 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 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 reach your Platform Connector.

Responses

Response samples

200

Content type

application/json

{ }

Customers

Operations to manage customers.

Create Customer

Creates a customer in your platform.

The request body contains a complete customer entity, which is persistently stored 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

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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (createCustomerRequestData)

object (customerNew)

email required	string <email> Email address for the customer
first_name	string First name of the customer
last_name	string Last name of the customer
phone	string <phone> Phone number for the customer
	Array of objects (addressNew) [ items ] List of customer addresses

Responses

Request samples

Payload

Content type

application/json

{"data": {"customer": {"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"addresses": [{"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
]
}
}
}

Response samples

201
500

Content type

application/json

{"data": {"customer": {"addresses": [{"platform_id": "Address_456",
"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
],
"platform_created_at": "2019-08-24T14:15:22Z",
"platform_updated_at": "2019-08-24T14:15:22Z",
"platform_id": "Customer_123",
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555"
}
}
}

List Customers

Lists all customers that have made a purchase from your store.

Returns a page of customers for your store limited by limit and paginated by cursor. Customers are returned in ascending order of platform_id. If a limit is not supplied or is invalid, then the default limit is used. If no cursor is supplied, the first page of results is returned. Subsequent calls with each new cursor can be made for additional data in the dataset. If there is no following dataset, then the next cursor should be empty.

Cursors have no requirements on how they are encoded, since they are opaque to the consumer. Each cursor should point to a location in the dataset. They can be supplied to subsequent calls for additional data in the dataset.

Authorizations:

HMAC

path Parameters

shop_identifier

required

string

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 Maximum number of results to return per page.
email	string Email used to filter the results.
cursor	string Cursor to obtain the next page of results. The value of the cursor will be taken directly from 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 RFC3339 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 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 reach your Platform Connector.

Responses

Response samples

200
500

Content type

application/json

{"data": {"customers": [{"addresses": [{"platform_id": "Address_456",
"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
],
"platform_created_at": "2019-08-24T14:15:22Z",
"platform_updated_at": "2019-08-24T14:15:22Z",
"platform_id": "Customer_123",
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555"
}
]
},
"pagination": {"next": "dGVzdGluZ3Rlc3Rpbmd0ZXN0aW5n",
"prev": "dW50ZXN0dW50ZXN0dW50ZXN0"
}
}

Delete Customer

Deletes a customer specified by platform_id. The customer should be marked as deleted within the platform.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Responses

Response samples

204
404
500

Content type

application/json

{ }

Update Customer

Updates a customer specified by platform_id.

All fields of a customer object are replaced with the values provided in the request body. Fields omitted from the request body are ignored in the Customer object.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (updateCustomerRequestData)

object (customerUpdate)

	Array of objects (addressNew) [ items ] List of customer addresses
email	string <email> Email address for the customer
first_name	string First name of the customer
last_name	string Last name of the customer
phone	string <phone> Phone number for the customer

Responses

Request samples

Payload

Content type

application/json

{"data": {"customer": {"addresses": [{"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
],
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555"
}
}
}

Response samples

200
404
500

Content type

application/json

{"data": {"customer": {"addresses": [{"platform_id": "Address_456",
"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
],
"platform_created_at": "2019-08-24T14:15:22Z",
"platform_updated_at": "2019-08-24T14:15:22Z",
"platform_id": "Customer_123",
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555"
}
}
}

Validate Customer JWT

Validates 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.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (customerValidateRequestData)

object (tokenInfo)

token

required

string

The token to introspect.

Responses

Request samples

Payload

Content type

application/json

{"data": {"token_info": {"token": "your token value"
}
}
}

Response samples

200
404
500

Content type

application/json

{"data": {"token_status": {"active": true
}
}
}

Addresses

Operations to manage customer addresses.

Create Address

Creates an address for a customer specified by platform_customer_id.

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

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_customer_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (createAddressRequestData)

object (addressNew)

address_type	string Type of the address (i.e., residential, commercial).
address_use	string Enum: "billing" "shipping" Usage of the address. Possible values are `"billing"` or `"shipping"`.
company	string Name of the company operating at the specified address, if applicable.
city	string Name of the city associated with the address.
country	string Name of the country associated with the address.
country_code	string 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 First name of the customer with the address.
last_name	string Last name of the customer with the address.
phone	string <phone> Phone number of the address.
postal_code	string Postal code or zip code for the address.
province	string Province or state for the address.
province_code	string Province or state abbreviation for the address.
street_1	string Primary street information for the address.
street_2	string Additional street information for the address.

Responses

Request samples

Payload

Content type

application/json

{"data": {"address": {"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
}
}

Response samples

201
404
500

Content type

application/json

{"data": {"address": {"platform_id": "Address_456",
"platform_customer_id": "Customer_123",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
}
}

Delete Address

Deletes an address. The address to be deleted is indicated by the platform_id and platform_customer_id. The address is marked as deleted.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_customer_id required	string Unique identifier for the customer. Assigned by the platform.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Responses

Response samples

204
404
500

Content type

application/json

{ }

Update Address

Updates an address. The address to be updated is indicated by the platform_id and platform_customer_id.

All fields of an address object are replaced with the values provided in the request body. Fields omitted from the request body are ignored and unchanged in the Address object.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_customer_id required	string Unique identifier for the customer. Assigned by the platform.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (updateAddressRequestData)

object (addressNew)

address_type	string Type of the address (i.e., residential, commercial).
address_use	string Enum: "billing" "shipping" Usage of the address. Possible values are `"billing"` or `"shipping"`.
company	string Name of the company operating at the specified address, if applicable.
city	string Name of the city associated with the address.
country	string Name of the country associated with the address.
country_code	string 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 First name of the customer with the address.
last_name	string Last name of the customer with the address.
phone	string <phone> Phone number of the address.
postal_code	string Postal code or zip code for the address.
province	string Province or state for the address.
province_code	string Province or state abbreviation for the address.
street_1	string Primary street information for the address.
street_2	string Additional street information for the address.

Responses

Request samples

Payload

Content type

application/json

{"data": {"address": {"address_type": "commercial",
"address_use": "billing",
"company": "Acme Corp.",
"city": "Winnipeg",
"country": "Canada",
"country_code": "CA",
"is_default": true,
"first_name": "John",
"last_name": "Doe",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"province": "Manitoba",
"province_code": "MB",
"street_1": "123 North Road",
"street_2": "string"
}
}
}

Response samples

200
404
500

Content type

application/json

{"data": {"address": {"platform_id": "Address_456",
"platform_customer_id": "Customer_123",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
}
}

Orders

Operations to manage orders.

List Orders

Lists all orders made to a given store.

Returns a page of orders for a given store limited by limit and paginated by cursor. Orders are returned in ascending order of platform_id. If a limit is not supplied or is invalid, then the default limit (250) is used. If no cursor is supplied, this endpoint returns the first page of results. Subsequent calls with each new cursor can be made for additional data in the dataset. If there is no additional data in the dataset to return, then the next cursor should be empty.

Cursors have no requirements on how they are encoded, since they are opaque to the consumer. Each cursor should point to a location in the dataset. They can be supplied to subsequent calls for additional data in the dataset.

Authorizations:

HMAC

path Parameters

shop_identifier

required

string

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 Maximum number of results to return per page.
cursor	string Cursor to obtain the next page of results. The value of the cursor will be taken directly from 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 RFC3339 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 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 reach your Platform Connector.

Responses

Response samples

200
500

Content type

application/json

{"data": {"orders": [{"platform_id": "string",
"platform_updated_at": "2019-08-24T14:15:22Z",
"shipping_addresses": [{"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
],
"billing_address": {"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
},
"line_items": [{"platform_id": "string",
"platform_product_id": "string",
"platform_variant_id": "string",
"cart_line_item_platform_id": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"title": "Shoes (long-laced classic)",
"sku": "string",
"url": "string",
"image": "string",
"quantity": 0,
"grams": 0,
"weight": 0,
"weight_unit": "string",
"taxable": true,
"taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"requires_shipping": true,
"price_per_item": "string",
"discount_per_item": "string",
"total": "string",
"subtotal": "string",
"total_tax": "string",
"discounted_subtotal": "string"
}
],
"payments": [{"platform_id": "string",
"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "stripe",
"payment_method": "credit card",
"currency": "CAD",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
],
"placed_at": "2019-08-24T14:15:22Z",
"order_number": "ORDER_XXYY1122",
"platform_customer_id": "string",
"shipping_method": "freight",
"browser_ip": "127.0.0.1",
"source": "POS",
"created_via": "Bold Checkout",
"locale": "en_US",
"test": true,
"notes": "string",
"public_notes": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"shipping_subtotal": "string",
"shipping_tax": "string",
"shipping_taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"discount": "string",
"subtotal": "string",
"subtotal_tax": "string",
"total_tax": "string",
"total": "string",
"refunded_amount": "string",
"currency": "CAD",
"order_status": "active",
"fulfillment_status": "pending",
"financial_status": "held_for_review"
}
]
},
"pagination": {"next": "dGVzdGluZ3Rlc3Rpbmd0ZXN0aW5n",
"prev": "dW50ZXN0dW50ZXN0dW50ZXN0"
}
}

Create Order

Creates an order in the platform.

The request body contains a complete order entity, which is persistently stored 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. The returned platform_id can be used in requests to other endpoints in this API.

Authorizations:

HMAC

path Parameters

shop_identifier

required

string

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 RFC3339 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 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 reach your Platform Connector.
Idempotency-Key	string The HTTP Idempotency request header field can be used 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

object (createOrderRequestData)

object (orderRequest)

	Array of objects (addressRequest) [ items ] List of shipping addresses for the order.
	object Billing address for the order.
	Array of objects (lineItemRequest) [ items ] List of line items for the order.
	Array of objects (paymentRequest) [ items ] List of payments for this order.
order_number	string Human-readable identifier for the order.
platform_customer_id	string Unique identifier for the customer associated to this order. Assigned by the platform.
shipping_method	string Method of shipping for the order.
browser_ip	string Browser IP under which the order was placed by the customer.
source	string Label noting the mechanism which placed this order.
created_via	string Label noting which app created the order (if applicable).
locale	string Locale code of the order (either in ISO-639 language code format or in ISO/IEC-15897 regional language format).
test	boolean Indicator of whether this is a test order.
notes	string Internal notes about the order.
public_notes	string Customer-facing notes about the order.
	object Key-value pairs of metadata relevant to the order.
shipping_subtotal	string <money> Cost of the shipping for the ordered items, in the order's given currency.
shipping_tax	string <money> Sum of the shipping taxes for the ordered items, in the order's given currency.
	Array of objects (tax) [ items ] List of all individual shipping taxes for each line item on the order.
discount	string <money> Total amount discounted from this order, in the order's given currency. Note: If `discount` is included in a payload, the `total` and `total_tax` values are required.
subtotal	string <money> Subtotal of all line items on the order, in the order's given currency. Note: Subtotals should be calculated before taxes and discounts (if those values are not included in the line item prices).
subtotal_tax	string <money> Tax to be charged on all line items, in the order's given currency.
total_tax	string <money> 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 <money> Grand total of the order cost, in the order's given currency. Note: Includes taxes and reduced by discount.
refunded_amount	string <money> Refunded amount of the order, if any, in the order's given currency.
currency	string Base currency used for the order (in ISO-4217 currency code format).
order_status	string Enum: "active" "cancelled" Current status of the order. Indicates whether the order has been cancelled.
fulfillment_status	string Enum: "pending" "partial" "delivered" "fulfilled" Fulfillment status of the order.
financial_status	string Enum: "held_for_review" "disputed" "cancelled" "pending" "preauthed" "refunded" "partially_paid" "partially_refunded" "paid" Status of payments associated with the order. This field can only be set when the order is created.

Responses

Request samples

Payload

Content type

application/json

{"data": {"order": {"shipping_addresses": [{"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
],
"billing_address": {"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
},
"line_items": [{"platform_product_id": "string",
"platform_variant_id": "string",
"cart_line_item_platform_id": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"title": "Shoes (long-laced classic)",
"sku": "string",
"url": "string",
"image": "string",
"quantity": 0,
"grams": 0,
"weight": 0,
"weight_unit": "string",
"taxable": true,
"taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"requires_shipping": true,
"price_per_item": "string",
"discount_per_item": "string",
"total": "string",
"subtotal": "string",
"total_tax": "string",
"discounted_subtotal": "string"
}
],
"payments": [{"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "string",
"payment_method": "string",
"currency": "string",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
],
"order_number": "ORDER_XXYY1122",
"platform_customer_id": "string",
"shipping_method": "freight",
"browser_ip": "127.0.0.1",
"source": "POS",
"created_via": "Bold Checkout",
"locale": "en_US",
"test": true,
"notes": "string",
"public_notes": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"shipping_subtotal": "string",
"shipping_tax": "string",
"shipping_taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"discount": "string",
"subtotal": "string",
"subtotal_tax": "string",
"total_tax": "string",
"total": "string",
"refunded_amount": "string",
"currency": "CAD",
"order_status": "active",
"fulfillment_status": "pending",
"financial_status": "held_for_review"
}
}
}

Response samples

201
500

Content type

application/json

{"data": {"order": {"platform_id": "string",
"platform_updated_at": "2019-08-24T14:15:22Z",
"shipping_addresses": [{"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
],
"billing_address": {"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
},
"line_items": [{"platform_id": "string",
"platform_product_id": "string",
"platform_variant_id": "string",
"cart_line_item_platform_id": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"title": "Shoes (long-laced classic)",
"sku": "string",
"url": "string",
"image": "string",
"quantity": 0,
"grams": 0,
"weight": 0,
"weight_unit": "string",
"taxable": true,
"taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"requires_shipping": true,
"price_per_item": "string",
"discount_per_item": "string",
"total": "string",
"subtotal": "string",
"total_tax": "string",
"discounted_subtotal": "string"
}
],
"payments": [{"platform_id": "string",
"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "stripe",
"payment_method": "credit card",
"currency": "CAD",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
],
"placed_at": "2019-08-24T14:15:22Z",
"order_number": "ORDER_XXYY1122",
"platform_customer_id": "string",
"shipping_method": "freight",
"browser_ip": "127.0.0.1",
"source": "POS",
"created_via": "Bold Checkout",
"locale": "en_US",
"test": true,
"notes": "string",
"public_notes": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"shipping_subtotal": "string",
"shipping_tax": "string",
"shipping_taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"discount": "string",
"subtotal": "string",
"subtotal_tax": "string",
"total_tax": "string",
"total": "string",
"refunded_amount": "string",
"currency": "CAD",
"order_status": "active",
"fulfillment_status": "pending",
"financial_status": "held_for_review"
}
}
}

Get Order

Retrieves an order that has been placed on your store by the specified platform_id.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Responses

Response samples

200
404
500

Content type

application/json

{"data": {"order": {"platform_id": "string",
"platform_updated_at": "2019-08-24T14:15:22Z",
"shipping_addresses": [{"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
],
"billing_address": {"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
},
"line_items": [{"platform_id": "string",
"platform_product_id": "string",
"platform_variant_id": "string",
"cart_line_item_platform_id": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"title": "Shoes (long-laced classic)",
"sku": "string",
"url": "string",
"image": "string",
"quantity": 0,
"grams": 0,
"weight": 0,
"weight_unit": "string",
"taxable": true,
"taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"requires_shipping": true,
"price_per_item": "string",
"discount_per_item": "string",
"total": "string",
"subtotal": "string",
"total_tax": "string",
"discounted_subtotal": "string"
}
],
"payments": [{"platform_id": "string",
"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "stripe",
"payment_method": "credit card",
"currency": "CAD",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
],
"placed_at": "2019-08-24T14:15:22Z",
"order_number": "ORDER_XXYY1122",
"platform_customer_id": "string",
"shipping_method": "freight",
"browser_ip": "127.0.0.1",
"source": "POS",
"created_via": "Bold Checkout",
"locale": "en_US",
"test": true,
"notes": "string",
"public_notes": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"shipping_subtotal": "string",
"shipping_tax": "string",
"shipping_taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"discount": "string",
"subtotal": "string",
"subtotal_tax": "string",
"total_tax": "string",
"total": "string",
"refunded_amount": "string",
"currency": "CAD",
"order_status": "active",
"fulfillment_status": "pending",
"financial_status": "held_for_review"
}
}
}

Update Order

Updates an order specified by platform_id.

All fields of an order object are replaced with the values provided in the request body. Fields omitted from the request body are ignored and are not updated in the Order object.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (updateOrderRequestData)

object (orderUpdateRequest)

fulfillment_status	string Enum: "pending" "partial" "delivered" "fulfilled" 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" Status of payments associated with the order. This value only be set when the order is created.
refunded_amount	string <money> Total refunded amount, if any, applied to the order. Measured in units of the order currency.
notes	string Plaintext internal notes about the order.
	object Key-value pairs of additional metadata relevant to the order.
	Array of objects (addressRequest) [ items ] List of shipping addresses for the order.
subtotal	string <money> Monetary total cost of the order, in the order's given currency. Note: This amount excludes tax and shipping costs.
subtotal_tax	string <money> Total cost of tax for all line items in the order, in the order's given currency.

Responses

Request samples

Payload

Content type

application/json

{"data": {"order": {"fulfillment_status": "pending",
"financial_status": "held_for_review",
"refunded_amount": "string",
"notes": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"shipping_addresses": [{"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
],
"subtotal": "string",
"subtotal_tax": "string"
}
}
}

Response samples

200
404
500

Content type

application/json

{"data": {"order": {"platform_id": "string",
"platform_updated_at": "2019-08-24T14:15:22Z",
"shipping_addresses": [{"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
}
],
"billing_address": {"platform_id": "string",
"address_type": "billing",
"first_name": "John",
"last_name": "Doe",
"street_1": "123 North Road",
"street_2": "string",
"city": "string",
"province": "Manitoba",
"country": "Canada",
"country_code": "CA",
"phone": "555-555-5555",
"postal_code": "H0H 0H0",
"email": "user@example.com",
"province_code": "MB",
"company": "Acme Corp."
},
"line_items": [{"platform_id": "string",
"platform_product_id": "string",
"platform_variant_id": "string",
"cart_line_item_platform_id": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"title": "Shoes (long-laced classic)",
"sku": "string",
"url": "string",
"image": "string",
"quantity": 0,
"grams": 0,
"weight": 0,
"weight_unit": "string",
"taxable": true,
"taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"requires_shipping": true,
"price_per_item": "string",
"discount_per_item": "string",
"total": "string",
"subtotal": "string",
"total_tax": "string",
"discounted_subtotal": "string"
}
],
"payments": [{"platform_id": "string",
"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "stripe",
"payment_method": "credit card",
"currency": "CAD",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
],
"placed_at": "2019-08-24T14:15:22Z",
"order_number": "ORDER_XXYY1122",
"platform_customer_id": "string",
"shipping_method": "freight",
"browser_ip": "127.0.0.1",
"source": "POS",
"created_via": "Bold Checkout",
"locale": "en_US",
"test": true,
"notes": "string",
"public_notes": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"shipping_subtotal": "string",
"shipping_tax": "string",
"shipping_taxes": [{"amount": "string",
"name": "Provincial Sales Tax",
"rate": "0.07",
"tag": "string"
}
],
"discount": "string",
"subtotal": "string",
"subtotal_tax": "string",
"total_tax": "string",
"total": "string",
"refunded_amount": "string",
"currency": "CAD",
"order_status": "active",
"fulfillment_status": "pending",
"financial_status": "held_for_review"
}
}
}

Create Payment

Create a payment associated with a given order.

The request body contains a complete order entity, which must be persistently stored on the 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 Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (createPaymentRequestData)

object (paymentRequest)

	Array of objects (transactionRequest) [ items ] List of transactions for the payment.
description	string Human-readable description of the payment.
provider	string Label indicating the organization handling the payment and transactions.
payment_method	string Payment method used.
currency	string Currency used for the payment (in ISO-4217 currency code format).
amount_planned	string <money> 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.
	object Key-value pairs of metadata relevant to the payment.
status	string Status of the payment. Values are dependent on the payment provider used and should be passed through as-is.

Responses

Request samples

Payload

Content type

application/json

{"data": {"payment": {"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "string",
"payment_method": "string",
"currency": "string",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
}
}

Response samples

201
404
500

Content type

application/json

{"data": {"payment": {"platform_id": "string",
"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "stripe",
"payment_method": "credit card",
"currency": "CAD",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
}
}

Update Payment

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

All fields of a payment object are replaced with the values provided in the request body. Fields omitted from the request body are ignored and are not updated in the Payment object.

Authorizations:

HMAC

path Parameters

shop_identifier required	string Unique identifier of the store. This can be retrieved by calling the Get Shop Info endpoint.
order_platform_id required	string Unique identifier for the order. Assigned by the platform.
platform_id required	string 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 RFC3339 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 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 reach your Platform Connector.

Request Body schema: application/json

object (updatePaymentRequestData)

object (updatePaymentRequest)

	Array of objects (transactionRequest) [ items ] List of transactions for the payment.
status	string Status of the payment. Values are dependent on the payment provider used and should be passed through as-is.

Responses

Request samples

Payload

Content type

application/json

{"data": {"payment": {"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"status": "string"
}
}
}

Response samples

200
404
500

Content type

application/json

{"data": {"payment": {"platform_id": "string",
"transactions": [{"platform_id": "string",
"provider_transaction_id": "string",
"amount": "string",
"currency": "CAD",
"status": "initial",
"type": "authorization"
}
],
"description": "string",
"provider": "stripe",
"payment_method": "credit card",
"currency": "CAD",
"amount_planned": "string",
"custom_attributes": {"property1": {"description": "string",
"value": "string"
},
"property2": {"description": "string",
"value": "string"
}
},
"status": "string"
}
}
}

Products

Operations to manage products.

List Products

Lists all products that exist in your store.

Returns a page of products for your store limited by limit and paginated by cursor. Products are returned in ascending order of platform_id. If a limit is not supplied or is invalid, the default limit is used. If no cursor is supplied, the first page of results is returned. Subsequent calls with each new cursor can be made for additional data in the dataset. If there is no following dataset, then the next cursor should be empty.

Cursors have no requirements on how they are encoded, since they are opaque to the consumer. Each cursor should point to a location in the dataset. They can be supplied to subsequent calls for additional data in the dataset.

Authorizations:

HMAC

path Parameters

shop_identifier

required

string

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

query Parameters

limit	integer <int32> [ 1 .. 250 ] Maximum number of results to return per page.
cursor	string Cursor to obtain the next page of results. The value of the cursor will be taken directly from the response without any modifications.

header Parameters

User-Agent required	string 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 reach your Platform Connector.
X-HMAC-Timestamp required	string <date-time> Example: 2021-03-11T17:16:51Z The UTC server time (in RFC3339 format) at the moment the request was sent, signed as a part of calculating X-HMAC and X-Compatible-HMAC values.

Responses

Response samples

200
500

Content type

application/json

{"data": {"products": [{"platform_id": "abc123456",
"platform_updated_at": "2019-08-24T14:15:22Z",
"categories": [{"platform_id": "abc123456",
"platform_updated_at": "2019-08-24T14:15:22Z",
"image_url": "your_platform_connector.com/files/categories/hats.jpg",
"name": "Hats"
}
],
"variants": [{"platform_id": "abc123456",
"option_values": [{"platform_id": "abc123456",
"platform_product_option_id": "VAR-10001-SM",
"label": "small",
"name": "Small"
}
],
"allow_backorder": true,
"compare_at_price": "30.00",
"cost": "30.00",
"grams": 0,
"image_url": "your_platform_connector.com/files/products/hats/purple-beach-hat.jpg",
"inventory_quantity": 0,
"inventory_tracking_entity": "variant",
"inventory_tracking_service": "platform",
"localized_names": {"en": "Purple",
"fr": "Violette"
},
"name": "Default Title",
"price": "30.00",
"require_shipping": true,
"sku": "BEACH-HAT-PURPLE",
"tax_code": "non-taxable",
"tax_exempt": true,
"weight": "1.0",
"weight_unit": "kg"
}
],
"options": [{"platform_id": "abc123456",
"option_values": [{"platform_id": "abc123456",
"is_default": true,
"label": "Small",
"position": 0
}
],
"name": "Small",
"position": 0
}
],
"images": [{"platform_id": "abc123456",
"name": "Beach hat",
"src": "your_platform_connector.com/files/images/beach-hat.jpg",
"position": 0
}
],
"description": "A hat for the beach",
"handle": "beach-hat",
"inventory_quantity": 0,
"inventory_tracking_entity": "variant",
"inventory_tracking_service": "platform",
"localized_descriptions": {"en": "A hat for the beach",
"fr": "Un chapeau pour la plage"
},
"localized_names": {"en": "Beach Hat",
"fr": "Chapeau de Plage"
},
"name": "Beach hat",
"published": true,
"tags": "clothing, unisex, pants",
"tax_code": "non-taxable",
"type": "physical",
"url": "/hats/beach-hat",
"vendor": "OFS"
}
]
},
"pagination": {"next": "dGVzdGluZ3Rlc3Rpbmd0ZXN0aW5n",
"prev": "dW50ZXN0dW50ZXN0dW50ZXN0"
}
}