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

Changed on Jul 7, 2026

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

post/api/v1/customers

Request

Base URL
https://oms-api.tenant.krzlabs.io
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/kruzer-corp/apis/oms-api/docs/api/v1/customers/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Jul 7, 2026a3b4750a505f Revision changes
- breaking
  added the new required request property
- breaking
  the request property type changed from object to string
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Jul 7, 202684194c31ab85 Revision changes
- breaking
  the request property type changed from string to object
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  the request property became nullable
- info
  the request property became optional

Operation history