Skip to main content
Documentation Powered by Redocly

Customers (2.0.0)

Download OpenAPI specification:Download

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

This API allows you to find information about your customers.

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

Authentication

OAuthToken

Authenticates an API request from a public integration. Generate this token in the Developer Dashboard. Refer to Build Public Integrations for more information.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://apps.boldapps.net/accounts/dashboard/authorize
Token URL: https://api.boldcommerce.com/auth/oauth2/token
Scopes:
  • read_customers -

    Read customer information.

APIAccessToken

Authenticates an API request from a private integration. Generate this token in the Bold Account Center. Refer to the Quick Start for more information.

Security Scheme Type API Key
Header parameter name: API Access Token

Customers

Contains information about the customers associated with a given store. Use these endpoints to retrieve information about one or all customers on your store.

Get Customer by ID

Retrieves a customer by the Bold-generated ID.

Authorizations:
OAuthToken (
  • read_customers
) APIAccessToken
    path Parameters
    shop_identifier
    required
    string
    Example: zp3oafdor9

    A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

    id
    required
    integer <int64>
    Example: 82435920

    A unique identifier for the customer, generated by Bold.

    Responses

    Response samples

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

    Get Customer by Platform ID

    Retrieves a customer by the platform-generated customer ID.

    Authorizations:
    OAuthToken (
    • read_customers
    )     APIAccessToken
      path Parameters
      shop_identifier
      required
      string
      Example: zp3oafdor9

      A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

      platform_id
      required
      string
      Example: 2

      A unique identifier for the customer, generated by the platform.

      Responses

      Response samples

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

      List Customers

      Lists the customers that have placed orders on the store.

      All query parameters must be URL-encoded. For more information about searching, refer to Query & Pagination.

      Authorizations:
      OAuthToken (
      • read_customers
      )       APIAccessToken
        path Parameters
        shop_identifier
        required
        string
        Example: zp3oafdor9

        A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

        query Parameters
        since_id
        integer <int64>
        Example: since_id=2459023599

        Specifies results that fall after the given ID.

        updated_at_min
        string <date-time>
        Example: updated_at_min=2020-01-01T00:00:00Z

        The earliest date (in RFC3339 format) that the customer was updated.

        updated_at_max
        string <date-time>
        Example: updated_at_max=2022-01-01T00:00:00Z

        The latest date (in RFC3339 format) that the customer was updated.

        search
        string
        Example: search=%27bob%20dylan%27

        A search term used to perform a fuzzy search across the customer's first_name, last_name, email, and phone.

        ids
        string
        Example: ids=142329453,23490134,40245842

        A comma-separated list of customer IDs.

        orderby
        string
        Example: orderby=first_name

        The method of ordering the returned results. Must be paired with the orderdirection query parameter.

        orderdirection
        string
        Example: orderdirection=asc

        The direction of ordering returned results. Must be paired with the orderby query parameter. Possible values include asc and desc.

        filter
        Array of strings
        Example: filter=eq(id:11)

        The filtering mechanism to apply to the query. For more information, refer to Query & Pagination.

        label
        string
        Example: label=loyal_cust

        The label assigned to the customer.

        limit
        integer <int32>
        Example: limit=50

        The number of results per page.

        page
        integer <int32>
        Example: page=2

        The page of results to return.

        Responses

        Response samples

        Content type
        application/json
        {
        • "pagination": {},
        • "customers": [
          ]
        }

        Validate Customer JWT

        Validates a customer JWT issued by the Bold platform. The JWT is used to make calls to the Checkout Frontend API.

        Authorizations:
        OAuthToken (
        • read_customers
        )         APIAccessToken
          path Parameters
          shop_identifier
          required
          string
          Example: zp3oafdor9

          A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

          platform_id
          required
          string
          Example: 2

          A unique identifier for the customer, generated by the platform.

          query Parameters
          jwt
          string
          Example: jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

          The JSON Web Token (JWT) generated during the initialization of the order.

          Responses

          Response samples

          Content type
          application/json
          { }

          Addresses

          Contains information about the shipping and billing addresses associated with a given store. Use these endpoints to retrieve information about one or all customer addresses on your store.

          Get Customer Address by ID

          Retrieves a customer address by the customer ID and the address ID.

          Authorizations:
          OAuthToken (
          • read_customers
          )           APIAccessToken
            path Parameters
            shop_identifier
            required
            string
            Example: zp3oafdor9

            A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

            customer_id
            required
            integer <int64>
            Example: 82435920147

            A unique identifier for the customer, generated by Bold.

            id
            required
            integer <int64>
            Example: 90235719

            A unique identifier for the address, generated by Bold.

            Responses

            Response samples

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

            List Customer Addresses

            Lists all customer addresses for your store. For more information about searching, refer to Query & Pagination.

            Authorizations:
            OAuthToken (
            • read_customers
            )             APIAccessToken
              path Parameters
              shop_identifier
              required
              string
              Example: zp3oafdor9

              A unique identifier for the store, generated by Bold. Retrieve this information by calling the Get Shop Info endpoint.

              customer_id
              required
              integer <int64>
              Example: 82435920147

              A unique identifier for the customer, generated by Bold.

              Responses

              Response samples

              Content type
              application/json
              {
              • "addresses": [
                ]
              }