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

Fetch customer

Returns the customer detail (identification + addresses) by its identifier.

get/api/v1/customers/{id}

Path parameters

idstring uuid required

Example:01920000-0000-7000-8000-000000000000

Customer identifier (UUID).

Response

Customer found.

idstring required

documentstring nullable required

type'PF' | 'PJ' nullable required

external_idstring nullable required

namestring required

emailstring nullable required

phonestring nullable required

birth_datestring nullable required

metadataobject nullable required

total_ordersnumber required

total_spentnumber required

first_order_atstring nullable required

last_order_atstring nullable required

created_atstring required

updated_atstring required

Changes

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

Jul 7, 2026a3b4750a505f16See the full diff
- ○
  added the required property addresses to the response with the 200 status
  response-required-property-added
- ○
  added the required property birth_date to the response with the 200 status
  response-required-property-added
- ○
  added the required property created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property document to the response with the 200 status
  response-required-property-added
- ○
  added the required property email to the response with the 200 status
  response-required-property-added
- ○
  added the required property external_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property first_order_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property id to the response with the 200 status
  response-required-property-added
- ○
  added the required property last_order_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property metadata to the response with the 200 status
  response-required-property-added
- ○
  added the required property name to the response with the 200 status
  response-required-property-added
- ○
  added the required property phone to the response with the 200 status
  response-required-property-added
- ○
  added the required property total_orders to the response with the 200 status
  response-required-property-added
- ○
  added the required property total_spent to the response with the 200 status
  response-required-property-added
- ○
  added the required property type to the response with the 200 status
  response-required-property-added
- ○
  added the required property updated_at to the response with the 200 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, 202684194c31ab8519See the full diff
- ▲
  removed the required property addresses from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property avg_ticket from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property birth_date from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property created_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property document from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property email from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property external_id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property first_order_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property last_order_at from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property origin from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property phone from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property phone_is_whatsapp from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property social_name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property total_orders from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property total_spent from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property updated_at from the response with the 200 status
  response-required-property-removed
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history