Skip to main content
POST
Criar pedido.
Cria um novo pedido CDC com os dados do cliente e as informações da venda.

Documentos e contato

Os campos cpf, celular e documentoEstabelecimento aceitam o valor com ou sem máscara:
  • cpf: 123.456.789-01 ou 12345678901.
  • celular: +55 (11) 91234-5678 ou +5511912345678.
  • documentoEstabelecimento: 12.345.678/0001-95 ou 12345678000195.
cpf e documentoEstabelecimento precisam ser documentos válidos (dígitos verificadores corretos).

Valor solicitado

O campo valorSolicitado representa sempre o valor bruto da venda.

Endereço

O campo endereco é obrigatório, junto com seus subcampos logradouro, cidade, estado, bairro, cep e numero. Apenas complemento é opcional.
  • estado deve ser uma UF válida (uma das 27 siglas, ex.: SP, RJ, MG).
  • cep deve ter 8 dígitos — aceita com ou sem máscara (01311-000 ou 01311000).

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Headers

Idempotency-Key
string<uuid>

Chave de idempotência para requisições de criação/alteração (POST). Recomendada para /v1/order, /v1/order/invoice e /v1/order/start-cdc-sale.

Use um identificador único por tentativa lógica de operação (ex.: um UUID gerado pelo seu sistema antes de chamar a API). Reenviar a mesma chave com o mesmo corpo de requisição, dentro de 24 horas, retorna a resposta original em vez de repetir a operação — útil para reintentar com segurança após timeout ou erro de rede.

Reenviar a mesma chave com um corpo de requisição diferente retorna 409 Conflict. Uma segunda requisição com a mesma chave enquanto a primeira ainda está em processamento também retorna 409 Conflict.

CorrelationId
string

Identificador de correlação da requisição, usado para rastreamento em logs e suporte. Se não for enviado, a API gera um novo automaticamente.

O valor é sempre devolvido no cabeçalho de resposta CorrelationId e também no campo correlationId do corpo, em respostas de erro (ProblemDetails).

Body

application/json
cpf
string
required

CPF válido do cliente. Aceita com ou sem máscara (ex. 123.456.789-01 ou 12345678901).

Minimum string length: 1
Example:

"12345678901"

celular
string
required

Telefone celular do cliente, com código do país. Aceita com ou sem máscara (ex. +55 (11) 91234-5678 ou +5511912345678).

Minimum string length: 1
Example:

"+55 (11) 91234-5678"

documentoEstabelecimento
string
required

CNPJ válido do estabelecimento. Aceita com ou sem máscara (ex. 12.345.678/0001-95 ou 12345678000195).

Minimum string length: 1
Example:

"12345678000195"

valorSolicitado
number<double>
required

Valor bruto da venda.

Example:

1500

nome
string
required
Minimum string length: 1
Example:

"João da Silva"

email
string
required
Minimum string length: 1
Example:

"joao.silva@email.com"

dataDeNascimento
string<date-time>
required
Example:

"2023-11-07T05:31:56Z"

endereco
object
required

Response

OK

pedidoId
string<uuid>