Create customer

Create a customer

curl --request POST \
  --url https://base_url/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
  "email": "[email protected]",
  "shipping_address": {
    "postal_code": "90401",
    "state": "CA",
    "country": "US",
    "address_line_1": "1776 Main St",
    "address_line_2": "Apt. #123",
    "address_line_3": "<string>",
    "city": "Santa Monica"
  },
  "external_id": "<string>"
}
'

{
  "data": {
    "id": "b6d009b0-d174-463f-b030-94643c28e209",
    "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "name": "John Doe",
    "email": "[email protected]",
    "shipping_address": {
      "postal_code": "90401",
      "state": "CA",
      "country": "US",
      "address_line_1": "1776 Main St",
      "address_line_2": "Apt. #123",
      "address_line_3": "<string>",
      "city": "Santa Monica"
    },
    "external_id": "<string>"
  },
  "message": "Successfully created customer."
}

POST

customers

Create a customer

curl --request POST \
  --url https://base_url/api/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
  "email": "[email protected]",
  "shipping_address": {
    "postal_code": "90401",
    "state": "CA",
    "country": "US",
    "address_line_1": "1776 Main St",
    "address_line_2": "Apt. #123",
    "address_line_3": "<string>",
    "city": "Santa Monica"
  },
  "external_id": "<string>"
}
'

{
  "data": {
    "id": "b6d009b0-d174-463f-b030-94643c28e209",
    "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "name": "John Doe",
    "email": "[email protected]",
    "shipping_address": {
      "postal_code": "90401",
      "state": "CA",
      "country": "US",
      "address_line_1": "1776 Main St",
      "address_line_2": "Apt. #123",
      "address_line_3": "<string>",
      "city": "Santa Monica"
    },
    "external_id": "<string>"
  },
  "message": "Successfully created customer."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

A display name for this customer.

Minimum string length: 3

Example:

"John Doe"

corporation_id

string

required

The unique identifier for a corporation this customer belongs to.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

string<email>

Email address of the customer.

shipping_address

object

Show child attributes

shipping_address.postal_code

string

required

Either 5-digit ZIP code or 9-digit ZIP+4 code is accepted.

Example:

"90401"

shipping_address.state

string

required

2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.

Example:

"CA"

shipping_address.country

string

required

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

shipping_address.address_line_1

string

Example:

"1776 Main St"

shipping_address.address_line_2

string

Example:

"Apt. #123"

shipping_address.address_line_3

string

shipping_address.city

string

Example:

"Santa Monica"

external_id

string

External identifier for the customer.

Response

Information about the created customer

data

object

Show child attributes

data.id

string

The unique identifier for this customer.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

data.corporation_id

string

The unique identifier for the corporation associated with this customer.

Example:

"2535af08-a139-4d0c-9827-1651e46dfbcf"

data.name

string

A display name for this customer.

Example:

"John Doe"

data.email

string<email>

Email address of the customer.

data.shipping_address

object

Show child attributes

data.shipping_address.postal_code

string

required

Either 5-digit ZIP code or 9-digit ZIP+4 code is accepted.

Example:

"90401"

data.shipping_address.state

string

required

2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.

Example:

"CA"

data.shipping_address.country

string

required

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

data.shipping_address.address_line_1

string

Example:

"1776 Main St"

data.shipping_address.address_line_2

string

Example:

"Apt. #123"

data.shipping_address.address_line_3

string

data.shipping_address.city

string

Example:

"Santa Monica"

data.external_id

string

External identifier for the customer.

message

string

Example:

"Successfully created customer."

Customers List customers

⌘I

Sales Tax API

Core Concepts

Corporations

Calculate

Transactions

Nexus

Registrations

Filings

Products

Customers

Exemption Certificates

Files

Webhooks

Authorizations

Body

Response