BOboldcommerce
Customers

Get Customer by ID

Retrieves a customer by the Bold-generated ID.

get/v2/shops/{shop_identifier}/customers/{id}

Request

Path parameters

shop_identifierstring required

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

idinteger required

A unique identifier for the customer, generated by Bold.

Response

A successful response.

Example response

{
  "customer": {
    "tags": "member, 2021",
    "shop_identifier": "zp3oafdor9",
    "platform_created_at": "2021-11-04T19:09:52Z",
    "id": 142329453,
    "platform_type": "bigcommerce",
    "last_name": "Doe",
    "first_name": "John",
    "labels": [
      {
        "id": 1,
        "customer_id": 82435920147,
        "name": "loyal_cust",
        "created_at": "2021-11-04T19:09:55Z",
        "updated_at": "2021-11-04T19:09:55Z"
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "active_sub",
        "description": "The customer is a subscriber to a product on this store via Bold Subscriptions",
        "shop_identifier": "zp3oafdor9",
        "platform_id": "group_1_plat",
        "created_at": "2021-08-01T20:11:31Z"
      }
    ],
    "updated_at": "2021-11-04T19:09:52Z",
    "phone": "2041438851",
    "platform_id": "1",
    "addresses": [
      {
        "city": "Winnipeg",
        "province": "Manitoba",
        "province_code": "MB",
        "country": "Canada",
        "created_at": "2021-11-04T19:09:52Z",
        "zip": "R3L0L6",
        "address_type": "residential",
        "platform_customer_id": "1",
        "address_use": "shipping",
        "company": "Acme Inc.",
        "street_2": "Suite 200",
        "platform_id": "address1234",
        "shop_identifier": "zp3oafdor9",
        "platform_type": "bigcommerce",
        "first_name": "John",
        "address_source": "platform",
        "last_name": "Doe",
        "updated_at": "2021-11-04T19:09:52Z",
        "phone": "2041438851",
        "is_default": true,
        "bold_customer_id": 1423294,
        "country_iso2": "CA",
        "street_1": "50 Fultz Blvd",
        "id": 90235719
      }
    ],
    "created_at": "2021-11-04T19:09:52Z",
    "email": "john.doe@example.com",
    "default_address": {
      "city": "Winnipeg",
      "province": "Manitoba",
      "province_code": "MB",
      "country": "Canada",
      "created_at": "2021-11-04T19:09:52Z",
      "zip": "R3L0L6",
      "address_type": "residential",
      "platform_customer_id": "1",
      "address_use": "shipping",
      "company": "Acme Inc.",
      "street_2": "Suite 200",
      "platform_id": "address1234",
      "shop_identifier": "zp3oafdor9",
      "platform_type": "bigcommerce",
      "first_name": "John",
      "address_source": "platform",
      "last_name": "Doe",
      "updated_at": "2021-11-04T19:09:52Z",
      "phone": "2041438851",
      "is_default": true,
      "bold_customer_id": 1423294,
      "country_iso2": "CA",
      "street_1": "50 Fultz Blvd",
      "id": 90235719
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.