The Customers resource is designed to manage customer data effectively by providing endpoints for various operations. It enables you to create new customer records, retrieve a list of existing customers, update details for specific customers, and remove customer records when necessary. This API is essential for maintaining accurate and up-to-date customer information within your application, ensuring seamless integration and efficient data handling.
Creates a new customer
Creates a new customer object
post
/customers
Authorizations
Body
idstring
The unique identifier of a customer.
Example: 5823594808
emailstring · email
The customer email address.
Example: jsmith@digitalriver.com
shippingShipping
defaultSourceIdstring
The identifier of the default source attached to this customer.
Example: fd74a5c5-0163-469a-ae8e-031f0259b576
taxCertificateTaxCertificate
metadataMetadata
Key-value pairs used to store additional data. Value can be string, boolean or integer types.
Example: {"coupon":"iOS"}
localestring
A locale designator that combines the two-letter ISO 639-1 language code with the ISO 3166-1 alpha-2 country code.
Example: en_US
typeCustomerType
The type of customer.
Example: individual
Options: business, individual
enabledboolean
Usually used to disable the customer. The default is <code>true</code>. If <code>false</code>, attempts to create orders for the customer will fail.