Skip to main content
Documentation Powered by Redocly

Customers (2.0.0)

Download OpenAPI specification:Download

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

This API allows you to find information about your customers.

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

Authentication

Bearer

Security Scheme Type API Key
Header parameter name: Authorization

Customers

Customer operations

List Customers

List the customers for your shop

For more information on search filter option
Authorizations:
Bearer
    path Parameters
    shop_identifier
    required
    string

    Path

    query Parameters
    since_id
    integer <int64>

    Query.

    updated_at_min
    string
    updated_at_max
    string
    search
    string
    ids
    string
    orderby
    string
    orderdirection
    string
    filter
    Array of strings
    label
    string
    limit
    integer <int32>
    page
    integer <int32>

    Responses

    Response samples

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

    Get Customer by Platform ID

    Find a customer by platform identifier (i.e. The ID of the category in the ecommerce platform)

    Authorizations:
    Bearer
      path Parameters
      shop_identifier
      required
      string
      platform_id
      required
      string

      Responses

      Response samples

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

      Validate Customer JWT

      Validates a JWT issued by Mayhem

      Authorizations:
      Bearer
        path Parameters
        shop_identifier
        required
        string
        platform_id
        required
        string
        query Parameters
        jwt
        string

        Query.

        Responses

        Response samples

        Content type
        application/json
        { }

        Get Customer by ID

        Find a customer by ID

        Authorizations:
        Bearer
          path Parameters
          shop_identifier
          required
          string
          id
          required
          integer <int64>

          Responses

          Response samples

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

          Addresses

          Customer Address operations

          List Customer Addresses

          List the customer addresses for your shop

          For more information on search filter option
          Authorizations:
          Bearer
            path Parameters
            shop_identifier
            required
            string
            customer_id
            required
            integer <int64>

            Responses

            Response samples

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

            Get Customer Address by ID

            Find a customer address by ID

            Authorizations:
            Bearer
              path Parameters
              shop_identifier
              required
              string
              customer_id
              required
              integer <int64>
              id
              required
              integer <int64>

              Responses

              Response samples

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