POST:customers.json

Description

Create one or multiple customers.

Permission bit: "customers.create"

Topic: Customers

Query Parameters

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Request Body

Array of CustomerCreate

Copy
[
  {
    "accepts_marketing": false,
    "addresses": [
      {
        "address1": "Chestnut Street 92",
        "address2": "Apartment 2",
        "city": "Louisville",
        "company": "Google inc.",
        "country": "US",
        "id": "ad_EQzGqWoY",
        "name": "John Smith",
        "phone": "5556251199",
        "plus_code": "PQ7W+WM",
        "province": "KY",
        "zip": "40202"
      }
    ],
    "customer_group_id": "cg_EQzGqWoY",
    "default_billing_address_id": "ad_EQzGqWoY",
    "default_shipping_address_id": "ad_EQzGqWoY",
    "display_name": "John S.",
    "email": "bob.norman@hostmail.com",
    "email_confirmed": false,
    "import_id": "ta_EQzGqWoY",
    "import_index": 56,
    "is_disposable_email": false,
    "language": "",
    "metadata": [
      {
        "key": "",
        "value": ""
      }
    ],
    "mobile": "45634634562",
    "mobile_notifications": false,
    "name": "John Smith",
    "password": "34hb5kj3h45k3",
    "preferred_currency": "USD",
    "reminder_messages": false,
    "tags": [
      ""
    ],
    "tax_exempt": false,
    "timezone": "(GMT-05:00) Eastern Time",
    "timezone_hint": "(GMT-05:00) Eastern Time",
    "webauthn_credential": "",
    "webauthn_session_id": ""
  }
]

Response Body

Array of Customer

Response Body Type

Loading module