Skip to main content
Documentation Powered by Redocly

Platform Connector: Integration Configurations (1.0.0)

Download OpenAPI specification:Download

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

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.

Authentication

bearerAuth

The API access token created in Bold Account Center. For more information about creating an API Access token, refer to the Quick Start.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Platform Connector Destinations

These endpoints allow you 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 considered the location of your platform connector server.

Subsequently, any time the specified topic resource is changed, 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 a single 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 also results in a synchronous request to the Verify Platform Connector Destination endpoint on your platform connector. If the verification endpoint does not respond correctly the request change with not be completed and an error response will be returned.

Authorizations:
bearerAuth
    path Parameters
    shop_identifier
    required
    string

    Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

    Request Body schema: application/json
    object (createDestinationRequestData)
    object (destinationNew)
    shop_identifier
    required
    string

    Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

    topic
    required
    string
    Enum: "customers" "orders" "products"

    The resource / entity in Bold's domain model which caused a call to a Platform Connector.

    This value must be unique among all of the destination objects for a given shop_identifier.

    destination
    required
    string <URL>

    The base URL that Bold will call when the related topic is created, updated, or deleted.

    Each topic may only have a single destination on the Platform Connector, and each destination corresponds to only one topic. You must make separate calls to register each destination.

    version
    required
    string

    The semantic version to be substituted into the path of the call made to a Platform Connector as per the Platform Connector specifications.

    timeout_ms
    required
    number

    The time (in milliseconds) that Bold will wait before terminating outbound calls to a platform connector. The recommended value is 10000 milliseconds. This value cannot exceed 20000 milliseconds.

    Responses

    Request samples

    Content type
    application/json
    {}

    Response samples

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

    List Destinations

    Lists all connections between Bold and your Platform Connector for the specified shop_identifier.

    These describe the expected calls any time the referenced topic resources are changed; your Platform Connector will be called on the specified destination base URL at the relevant path as per the Platform Connector specifications.

    Authorizations:
    bearerAuth
      path Parameters
      shop_identifier
      required
      string

      Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

      Responses

      Response samples

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

      Get Destination by ID

      Retrieves a specific connection between Bold and your Platform Connector for the specified shop_identifier by its unique id.

      The response describes the expected calls any time the referenced topic resource is changed; Bold makes a call to your Platform Connector destination base URL at the relevant path.

      Authorizations:
      bearerAuth
        path Parameters
        shop_identifier
        required
        string

        Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

        id
        required
        string

        Unique identifier of the destination.

        Responses

        Response samples

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

        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 in the Destination object.

        Subsequently, any time the specified topic resource is changed, Bold makes a call to your platform connector's destination field at the relevant path. For more information about implementing these paths, refer to Implement Platform Connector APIs.

        Each topic may only have a single 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 also results in a synchronous request to the Verify Platform Connector Destination endpoint on your platform connector. If the verification endpoint does not respond correctly the request change with not be completed and an error response will be returned.

        Authorizations:
        bearerAuth
          path Parameters
          shop_identifier
          required
          string

          Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

          id
          required
          string

          Unique identifier of the destination.

          Request Body schema: application/json
          object (updateDestinationRequestData)
          object (destinationUpdate)
          id
          integer

          The unique identifier for this destination.

          shop_identifier
          string

          Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

          topic
          string
          Enum: "customers" "orders" "products"

          The resource / entity in Bold's domain model which caused a call to a Platform Connector.

          This value must be unique among all of the destination objects for a given shop_identifier.

          destination
          string <URL>

          The base URL that Bold will call when the related topic is created, updated, or deleted.

          Each topic may only have a single destination on the Platform Connector, and each destination corresponds to only one topic. You must make separate calls to register each destination.

          version
          string

          The semantic version to be substituted into the path of the call made to a Platform Connector as per the Platform Connector specifications.

          timeout_ms
          number

          The time (in milliseconds) that Bold will wait before terminating outbound calls to a platform connector. The recommended value is 10000 milliseconds. This value cannot exceed 20000 milliseconds.

          Responses

          Request samples

          Content type
          application/json
          {}

          Response samples

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

          Delete Destination

          Deletes a specific connection between Bold and your Platform Connector for the specified shop_identifier by its unique id.

          After this call, topic changes which would normally trigger calls to a Platform Connector will no longer do so for the deleted topic.

          Authorizations:
          bearerAuth
            path Parameters
            shop_identifier
            required
            string

            Unique identifier of the store. Retrieve this information by calling the Get Shop Info endpoint.

            id
            required
            string

            Unique identifier of the destination.

            Responses

            Response samples

            Content type
            application/json
            { }