Sign in

v1

latestSwagger 2.02026-07-17148179252.3 KB
Customers

Create Customers

Creates Customers. Multiple customers can be created in one call. Required Fields

  • last_name
  • first_name
  • email Required Fields Customer Address
  • first_name
  • city
  • country_code
  • state_or_province
  • last_name
  • address1
  • postal_code Required Fields Attributes
  • Attributes must be created BEFORE creating a customer.
  • attribute_id
  • attribute_value -- This is input as a string, regardless of the Type.
post/customers

Request body

emailstring required

The email of the customer. Must be unique.

first_namestring required

The first name of the customer.

last_namestring required

The last name of the customer.

companystring

The company of the customer.

phonestring

The phone number of the customer.

notesstring

The customer notes.

tax_exempt_categorystring

The tax exempt category code for the customer.

customer_group_idinteger

Id of the group which this customer belongs to.

accepts_product_review_abandoned_cart_emailsboolean

It determines if the customer is signed up to receive either product review or abandoned cart emails or recieve both emails.

Example request

[
  {
    "addresses": [
      {
        "address1": "Addr 1",
        "address2": "",
        "address_type": "residential",
        "city": "San Francisco",
        "company": "History",
        "country_code": "US",
        "first_name": "Ronald",
        "last_name": "Swimmer",
        "phone": "707070707",
        "postal_code": "33333",
        "state_or_province": "California"
      }
    ],
    "attributes": [
      {
        "attribute_id": 55,
        "value": "string value"
      }
    ],
    "store_credit_amounts": [
      {
        "amount": 43.18
      }
    ]
  }
]

Response

OK

Example response

{
  "data": [
    {
      "authentication": {
        "force_password_reset": true
      },
      "addresses": [
        {
          "address_type": "residential"
        }
      ],
      "store_credit_amounts": [
        {
          "amount": 43.18
        }
      ]
    }
  ]
}