carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

customers

Create customer

Registers a new customer within the caller account. The document is deduplicated per account.

post/api/v1/customers

Request body

documentstring nullable

CPF (11 digits) or CNPJ (14 characters). Optional.

type'PF' | 'PJ' nullable

birth_datestring

Date of birth.

metadataobject nullable

namestring required

emailstring nullable

phonestring nullable

Example request

{
  "birth_date": "1990-05-20"
}

Response

Customer created.

idstring required

documentstring nullable required

type'PF' | 'PJ' nullable required

namestring required

emailstring nullable required

phonestring nullable required

birth_datestring nullable required

metadataobject nullable required

created_atstring required

updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.20516

Jul 7, 2026a3b4750a505f212See the full diff
- ▲
  added the new required request property name
  new-required-request-property
- ▲
  the document request property type/format changed from object/ to string/
  request-property-type-changed
- ○
  added the new optional request property email
  new-optional-request-property
- ○
  added the new optional request property phone
  new-optional-request-property
- ○
  added the required property birth_date to the response with the 201 status
  response-required-property-added
- ○
  added the required property created_at to the response with the 201 status
  response-required-property-added
- ○
  added the required property document to the response with the 201 status
  response-required-property-added
- ○
  added the required property email to the response with the 201 status
  response-required-property-added
- ○
  added the required property id to the response with the 201 status
  response-required-property-added
- ○
  added the required property metadata to the response with the 201 status
  response-required-property-added
- ○
  added the required property name to the response with the 201 status
  response-required-property-added
- ○
  added the required property phone to the response with the 201 status
  response-required-property-added
- ○
  added the required property type to the response with the 201 status
  response-required-property-added
- ○
  added the required property updated_at to the response with the 201 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab851854See the full diff
- ▲
  the document request property type/format changed from string/ to object/
  request-property-type-changed
- ▲
  removed the required property avg_ticket from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property birth_date from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property created_at from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property document from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property email from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property first_order_at from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property last_order_at from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property name from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property origin from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property phone from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property phone_is_whatsapp from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property social_name from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property total_orders from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property total_spent from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updated_at from the response with the 201 status
  response-required-property-removed
- ●
  removed the request property email
  request-property-removed
- ●
  removed the request property name
  request-property-removed
- ●
  removed the request property phone
  request-property-removed
- ●
  removed the request property phone_is_whatsapp
  request-property-removed
- ●
  removed the request property social_name
  request-property-removed
- ○
  added the new optional request property metadata
  new-optional-request-property
- ○
  added the new optional request property type
  new-optional-request-property
- ○
  the request property document became nullable
  request-property-became-nullable
- ○
  the request property document became optional
  request-property-became-optional
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history