Platform Connector: Integration Configurations (1.0.0)
Download OpenAPI specification:Download
This API allows authors of platform connectors to configure the integration between their platform connector and Bold services.
Refer to the changelog for the latest updates to this API.
Note: This specification is only for use with a Bold Platform Connector.
Contains information about where Bold should direct platform connector requests. Use these endpoints to integrate a platform connector with Bold by providing your server's destinations.
Create Destination
Informs Bold of your platform connector destination for the specified shop_identifier
. This destination is the location of your platform connector server.
Any time the specified topic
resource changes, Bold makes a call to your platform connector's destination
URL at the relevant path. For more information about implementing these paths, refer to Implement Platform Connector APIs.
Each topic may only have one destination on the platform connector, and each destination corresponds to only one topic. You must make separate calls to register each destination.
Any request to this endpoint triggers a synchronous request to the Verify Platform Connector Destination endpoint on your platform connector. If the verification endpoint does not succeed, the Create Destination call also fails.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
Request Body schema: application/jsonrequired
object (createDestinationRequestData) | |||||||||||||||
|
Responses
Request samples
- Payload
{- "data": {
- "destination": {
- "shop_identifier": "zp3oafdor9",
- "topic": "customers",
- "version": "v1",
- "timeout_ms": 10000
}
}
}
Response samples
- 200
- 400
- 500
{- "data": {
- "destination": {
- "id": 100,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "topic": "customers",
- "version": "v1",
- "timeout_ms": 10000
}
}
}
List Destinations
Lists all connections between Bold and your platform connector for the specified shop_identifier
.
Any time the referenced topic
resources are changed, Bold calls your platform connector on the specified destination
base URL at the relevant path, as per the Platform Connector Specifications.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
Responses
Response samples
- 200
- 500
{- "data": {
- "destination": {
- "id": 100,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-25T13:49:39Z",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "topic": "customers",
- "version": "v1",
- "timeout_ms": 10000
}
}
}
Get Destination by ID
Retrieves a specific connection between Bold and your platform connector for the specified shop_identifier
by its unique id
.
Any time the referenced topic
resources are changed, Bold calls your platform connector on the specified destination
base URL at the relevant path, as per the Platform Connector Specifications.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
id required | string Example: 100 A unique identifier of the destination. |
Responses
Response samples
- 200
- 404
- 500
{- "data": {
- "destination": {
- "id": 100,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "topic": "customers",
- "version": "v1",
- "timeout_ms": 10000
}
}
}
Update Destination
Updates the base URL destination
of your platform connector for the specified shop_identifier
.
All fields of a destination
object are replaced with the values provided in the request body. Fields omitted from the request body are ignored and not updated in the destination
object.
Any time the specified topic
resource changes, Bold makes a call to your platform connector's destination
URL at the relevant path. For more information about implementing these paths, refer to Implement Platform Connector APIs.
Each topic may only have one destination on the platform connector, and each destination corresponds to only one topic. You must make separate calls to update each destination.
Any request to this endpoint triggers a synchronous request to the Verify Platform Connector Destination endpoint on your platform connector. If the verification endpoint does not succeed, the Update Destination call also fails.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
id required | string Example: 100 A unique identifier of the destination. |
Request Body schema: application/jsonrequired
object (updateDestinationRequestData) | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "data": {
- "destination": {
- "id": 100,
- "shop_identifier": "zp3oafdor9",
- "topic": "customers",
- "version": "v1",
- "timeout_ms": 10000
}
}
}
Response samples
- 200
- 400
- 404
- 500
{- "data": {
- "destination": {
- "id": 100,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-25T13:49:39Z",
- "deleted_at": null,
- "shop_identifier": "zp3oafdor9",
- "topic": "customers",
- "version": "v1",
- "timeout_ms": 10000
}
}
}
Delete Destination
Deletes a specific connection between Bold and your platform connector for the specified shop_identifier
by the unique id
of the destination.
After this call, topic
changes which would normally trigger calls from Bold to a platform connector no longer do so for the deleted topic
.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 A unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint. |
id required | string Example: 100 A unique identifier of the destination. |
Responses
Response samples
- 204
- 404
- 500
{ }
Use these endpoints to sync your platform's customer, order, and product data with Bold.
Trigger Order Sync
Syncs the orders on a platform with Bold.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 The identifier of the shop you would like to sync. Retrieve the |
Responses
Response samples
- 200
- 409
- 501
{ }
Trigger Customer Sync
Syncs the customers on a platform with Bold.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 The identifier of the shop you would like to sync. Retrieve the |
Responses
Response samples
- 200
- 409
- 501
{ }
Trigger Product Sync
Syncs the products on a platform with Bold.
Authorizations:
path Parameters
shop_identifier required | string Example: zp3oafdor9 The identifier of the shop you would like to sync. Retrieve the |
Responses
Response samples
- 200
- 409
- 501
{ }