Recursos relacionados a pedidos, entidade que agrupa volumes.
GET
https://services.cliqueretire.com.br/ebox/api/v1/orders
Lista pedidos
GET
https://services.cliqueretire.com.br/ebox/api/v1/orders/:id
Busca informações de um pedido, utilizando o id do pedido.
POST
https://services.cliqueretire.com.br/ebox/api/v1/orders
Cria um pedido com seus pacotes
Informações do destinatário. (*) Required
Informações do volume (*)Required
Informações da nota fiscal (*)Required
POST
https://services.cliqueretire.com.br/ebox/api/v1/orders/return
Criação de pedidos com volumes para logística reversa.
Informações do destinatário. (*) Required
Informações do volume (*)Required
Informações da nota fiscal
DELETE
https://services.cliqueretire.com.br/ebox/api/v1/orders/:id
Deleta um pedido
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Content-Type
string
application/json
api-id
string
api-key
string
id
string
Id do pedido
Content-Type
string
application/json
api-id
string
api-key
string
Content-Type
string
application/json
api-id
string
api-key
string
invoice
object
Objeto com dados da nota fiscal
externalId
string
Identificador do pedido do embarcador
customer
object
Informações do destinatário
boxCode
string
Código do E-BOX
volumes
array
Volumes associados a esse pedido
urlCallback
string
URL para qual o webHook irá disparar os eventos relacionados ao pedido
Field
Description
cellphone*
Telefone do destinatário (5521999999999)
email*
string
fullName
string
documentNumber
string
Field
Description
expressNumber*
Código de barras do pacote
designationSize
ENUM ["S", "M", "L"]
externalId
string
Field
Description
series
Número de série da nota fiscal
number
Número da nota fiscal
key
Chave da nota fiscal
date
Data de emissão da nota fiscal
dateIso
Data de emissão da nota fiscal formato ISO
totalValue
Valor total da nota fiscal
productsValue
Valor total dos produtos
insured
Produto assegurado
Application-Type
string
application/json
api-id
string
string
api-key
string
string
invoice
string
Objeto com dados da nota fiscal
externalId
string
Identificador do pedido do embarcador
customer
string
Informações do destinatário
boxCode
string
Código do E-BOX
volumes
string
Volumes associados a esse pedido
urlCallback
string
URL para qual o webhook irá disparar eventos relacionados aos pedidos
Field
Description
cellphone*
Telefone do destinatário (5521999999999)
email*
string
fullName
string
documentNumber
string
Field
Description
expressNumber*
Código de barras do pacote
designationSize
ENUM ["S", "M", "L"]
externalId
string
Field
Description
series
Número de série da nota fiscal
number
Número da nota fiscal
key
Chave da nota fiscal
date
Data de emissão da nota fiscal
dateIso
Data de emissão da nota fiscal formato ISO
totalValue
Valor total da nota fiscal
productsValue
Valor total dos produtos
insured
Produto assegurado
id
string
Id do pedido
Content-Type
string
application/json
api-id
string
string
api-key
string
string