Skip to main content
POST
Criar pedido (frota própria)

Authorizations

Authorization
string
header
required

JWT token obtido via endpoint /auth/login

Body

application/json
externalOrderId
string

ID do pedido no ERP/cliente (opcional).

Example:

"PED-10023"

tenantId
string<uuid>

ID do tenant. Apenas para admins; por padrão usa o tenant do usuário ou o primeiro ativo.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

recipient
object
originZip
string

CEP de origem (opcional).

Pattern: ^\d{5}-?\d{3}$
Example:

"01001-000"

destinationZip
string

CEP de destino.

Pattern: ^\d{5}-?\d{3}$
Example:

"89010-000"

notes
string

Observações da entrega.

Example:

"Entregar somente após as 14h. Documento: NF-e 12345."

items
object[]

Itens/produtos do pedido.

Response

Pedido criado com sucesso.

shipmentId
string<uuid>

ID do envio criado.

trackingCode
string

Código de rastreio gerado.

status
enum<string>
Available options:
PENDING
recipientName
string
destinationZip
string