Bold provides several sets of specifications to help you get started building a platform connector. Read each section below for more information about each, or start exploring the provided spec files.
Platform Connector Configuration
Bold provides several endpoints for you to set up and configure your platform connector.
Platform Connector Destinations
Allows authors of Platform Connectors to configure the integration between their Platform Connector and Bold services.
Platform Connector Sync
Allows authors of Platform Connectors to sync store data without re-installing the connector.
If your platform is not officially supported by Bold, you must implement a server that allows Bold to retrieve and manipulate product, order, and customer data.
Create this server based on the Platform Connector API Specifications, which define the ways that Bold expects to interact with your chosen platform.
For more information, refer to Implement Platform Connector APIs.
Allows Bold to interact with your platform's customers and addresses.
Allows Bold to interact with your platform's orders.
Allows Bold to interact with your platform's products, variants, categories, images, and options.
Platform Event Notifications
In addition to a standard API, a platform connector must also send events that notify Bold when a change happens in the platform. You must also set up your server to make calls to the Platform Event Notifications endpoints whenever your customers, orders, and products change on the platform.
For more information, refer to Implement Platform Event Notifications.
Allows platform connectors to push events to Bold when there are changes to a Customer resource.
Allows platform connectors to push order change events to Bold when there are changes to an Order resource.
Allows platform connectors to push events to Bold when there are changes to a Product resource.