Customers

Create customer

View as Markdown

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired
Preferred company name
companyNamestringOptional
Legal company name
primaryBillingContactEmailstringOptional
Email of primary billing contact
billingAddressobjectOptional
Customer's billing address
shippingAddressobjectOptional
Customer's shipping address
defaultCurrencyenumOptional
Default currency code for the customer, if omitted will default to USD
customFieldslist of objectsOptional

Custom fields to pass during customer creation (NetSuite only). Each field key should match the internal field id.

customerTaxInfoobjectOptional
Customer tax information

Response

Customer created in Tabs. When the merchant has an ERP connected, jobId is the sync job’s ID and statusEndpoint points at it. When there’s no ERP, jobId is null and statusEndpoint points at the customer instead.

payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

500
Internal Server Error