Cria um novo pedido

Authorizations

x-api-key

string

header

required

Chave da API gerada no agulhão

Body

application/json

Dados do pedido a ser criado

number

ID do pedido no Agulhão (se não existir ou não for encontrado a partir do idExterno, será gerado um novo)

idExterno

string

ID do pedido na integração (seu id)

descontoDinheiro

number<float>

Desconto em dinheiro aplicado ao pedido

Example:

10

valorFrete

number<float>

Valor do frete

Example:

15

observacoes

string

Observações do pedido

Example:

"Observações do pedido"

valorOutros

number<float>

Valor de outros custos adicionais do pedido

Example:

5

cancelado

boolean

Indica se o pedido foi cancelado

Example:

false

tipoPedido

string

Tipo do pedido

filialCod

string

Código da filial onde o pedido foi realizado

tipoFrete

string

Tipo de frete do pedido

dataEmissao

string<date-time>

Data de emissão do pedido

Example:

"2025-01-01T00:00:00"

dataFechamento

string<date-time>

Data de fechamento do pedido

Example:

"2025-01-02T00:00:00"

guiaCod

number

Código do guia associado ao pedido

Example:

1

vendedorCod

number

Código do vendedor associado ao pedido

Example:

1

transportadoraCod

number

Código da transportadora associada ao pedido

Example:

1

gerenteProjetoCod

number

Código do gerente de projeto associado ao pedido

Example:

1

responsavelCod

number

Código do responsável pelo pedido

Example:

1

tipoLancamentoCod

number

Código do tipo de lançamento do pedido

Example:

1

cliente

object

Show child attributes

cliente.pessoaCod

number

Código da pessoa/cliente (se ja existir no agulhao)

Example:

1

cliente.documento

string

CNPJ ou CPF do cliente

Example:

"00000000000000"

cliente.telefone

string

Telefone do cliente

Example:

"1112345678"

cliente.email

string

E-mail do cliente

Example:

"[email protected]"

cliente.nome

string

Nome do cliente

Example:

"Nome do Cliente"

cliente.logradouro

string

Logradouro do endereço do cliente

Example:

"Avenida Paulista"

cliente.complemento

string

Complemento do endereço do cliente

Example:

"Apto 101"

cliente.numero

string

Número do endereço do cliente

Example:

"1000"

cliente.bairro

string

Bairro do endereço do cliente

Example:

"Bela Vista"

cliente.cidade

string

Nome da cidade do endereço do cliente

Example:

"São Paulo"

cliente.uf

string

Sigla da unidade federativa do endereço do cliente

Example:

"SP"

cliente.ibgeCidade

string

Código IBGE da cidade do endereço do cliente

Example:

"3550308"

entrega

object

Show child attributes

entrega.logradouro

string

Logradouro do endereço de entrega

Example:

"Avenida Paulista"

entrega.complemento

string

Complemento do endereço de entrega

Example:

"Apto 101"

entrega.numero

string

Número do endereço de entrega

Example:

"1000"

entrega.bairro

string

Bairro do endereço de entrega

Example:

"Bela Vista"

entrega.cidade

string

Nome da cidade do endereço de entrega

Example:

"São Paulo"

entrega.uf

string

Sigla da unidade federativa do endereço de entrega

Example:

"SP"

entrega.ibgeCidade

string

Código IBGE da cidade do endereço de entrega

Example:

"3550308"

produtos

object[]

Show child attributes

produtos.id

string

required

Identificador único do produto

Example:

"1"

produtos.idGrade

string

required

Identificador único da grade do produto

Example:

"1"

produtos.quantidade

number<integer>

required

Quantidade do produto no pedido

Example:

1

produtos.valorUnitario

number<float>

required

Valor unitário do produto no pedido

Example:

100

pagamentos

object[]

Show child attributes

pagamentos.valor

number<float>

required

Valor do pagamento

Example:

100

pagamentos.pago

boolean

Indica se o pagamento foi realizado

Example:

false

pagamentos.gateway

string

Gateway de pagamento utilizado

Example:

"MERCADO PAGO"

Response

Pedido criado com sucesso

idAgulhao

string

Identificador único do pedido criado no Agulhão

Example:

"1"

idExterno

string

Identificador único do pedido na integração (seu id)

Example:

"4560a17a-ea59-4c4b-a2a4-78610dd04d4a"

produtos-bt

pedidos-bt

pessoas-bt

tipos-lancamento-bt

filiais-bt

Cria um novo pedido

Authorizations

Body

Response