Skip to main content
POST
Criação de entrega

Authorizations

token
string
query
required

Token de autenticação via query parameter. Pode representar o ID público da operação (Operador Logístico) ou o ID público do embarcador (Restaurante, loja, farmácia).

Query Parameters

live_mode
boolean
required

Especifica o ambiente para executar a requisição.

customer
boolean
required

Define o tipo de autenticação: true = Embarcador (Restaurante, Loja, Farmácia) false = Operação (Operador Logístico)

Body

application/json
specifications
object
required

Especificações da entrega

addresses
object
required

Pontos da entrega (Ponto de entrega e Ponto de coleta)

Response

Requisição processada com sucesso.

IMPORTANTE: se o valor do campo 'success' for diferente de 1, houve um erro na criação da entrega. Em caso de erro, valide o campo 'message' para mais detalhes.

success
integer

Indica se a requisição foi processada com sucesso. 1 = Sucesso, qualquer outro valor indica que houve um erro.

Example:

1

message
string

Mensagem de retorno da solicitação

Example:

"Solicitação recebida com sucesso!"

tracking
string

Identificador da entrega

Example:

"6b0187ae9bb6a5cb809308508133d32e83c5efe0e9fb297fea8283505a3b23dc"

orderId
string

Número da entrega na operação

Example:

"123"

pincode
string

Código de confirmação por PIN Code. Este campo estará presente somente se a entrega tiver confirmação por PIN Code. ATENÇÃO: É importante que guarde o valor, pois não será fornecido posteriormente.

Example:

"1234"