Pular para o conteúdo principal
API docs by Redocly

Box Delivery Documentação (1.0.0)

Download OpenAPI specification:Download

API Box Delivery

HOST PRODUCTION: https://api.boxdelivery.app/order-hub

HOST STAGING: https://api-stg.boxdelivery.app/order-hub

x-api-key é informado pela operação ao comércio após a primeira integração (Usado apenas em produção, será descontinuado).

Authorization é informado pela operação a cada novo comércio cadastro no nosso sistema. Este token é diferente para cada loja integrada.

default

Criação de Pedido

Cria um novo pedido dentro do Hub Box Delivery

Propriedade
Tipo
Obrigatório
Descrição
external_idStringSimIndentificador interno do sistema da empresa
short_external_referenceStringSimIndentificador de codigo amigavel, normalmente o codigo passado da empresa para o suporte
vehicle_typeIntNãoTipo de veículo que ira realizar a entrega.
Padrão 11 = Moto2 = Carro3 = Bicicleta
courier_must_returnIntNãoSem retorno ou Com retorno.
Padrão falsefalsetrue
delivery_typeStringNãoTipo de coleta de pedido.
Padrão DELIVERY
INDOOR
REVERSE
TAKEOUT
DELIVERY
address.cityStringSimCidade do cliente
address.countryStringSimPaís do cliente
address.latFloatSimLatitude do endereço do cliente
address.lngFloatSimLongitude do endereço do cliente
address.neighborhoodStringSimBairro do endereço do cliente
address.postal_codeStringSimCEP do endereço do cliente. Enviar apenas números. Não utilizar hífen, ponto ou traço.
address.stateStringSimEstado do endereço do cliente
address.street_nameStringSimLogradouro do endereço do cliente
address.street_numberStringSimNúmero do endereço do cliente
Em caso de não haver informação para complemento enviar 000
address.complementStringSimComplemento do endereço do cliente
Em caso de não haver informação para complemento enviar 000
customer.documentStringSimCPF do cliente
Enviar apenas números. Não utilizar hífen, ponto ou traço.
customer.nameStringSimNome completo do cliente
customer.phoneStringSimTelefone completo com DDD do cliente,
Enviar apenas números. Não utilizar hífen, parenteses, +, ponto ou traço.
payments.nameStringSimDescrição do meio de pagamento
payments.codeStringSimCódigo do tipo de pagamento
Ver abaixo a tabela Tipos de Códigos de Pagamento
payments.valueFloatSimValor a ser pago pelo cliente
payments.prepaidBooleanSimInforma se o pedido é ou não pré-pago
delivery_datetimeDate/TimeSimData da estimativa de entrega da empresa
preparation_startDate/TimeSimData/Hora do início preparacao do pedido pela empresa
order_created_atDate/TimeSimData de criacao do pedido
preparation_time_in_secondsDate/TimeSimTempo de preparo em segundos
total_priceFloatSimValor total do pedido
marketplace_nameStringSimNome do markeplace integrado

Exemplo: Ifood, Ubereats, Rappi
marketplace_idStringSimId do pedido no marktplace.

No caso do ifood, enviar o UUID.
items.nameStringSimNome do produto
items.priceFloatSimValor do produto
items.quantityIntegerSimQuantidade do produto
items.total_priceFloatSimValor do produto multiplicado pela quantidade do produto
items.external_idStringSimIndentificador interno do seu produto
Em caso de não haver informação para identificador enviar 000
items.observationsTextNãoObservações do produto
observationsTextNãoObservações do pedido
not_routingBooleanNãoPadrão false
Tipos de Código de Pagamento
CódigoDescrição
ONLINEPagamento online
IFOOD_ONLINE-
MC-
AM-
ALR-
ALA-
APL_MC-
APL_VIS-
CARNET-
CHF-
DNR-
ELO-
ELOD-
GPY_ELO-
GPY_MC-
GPY_MXMC-
GPY_MXVIS-
GPY_VIS-
HIPER-
IFE-
LPCLUB-
MCMA-
MOVPAY_AM-
MOVPAY_DNR-
MOVPAY_ELO-
MOVPAY_HIPER-
MOVPAY_MC-
MOVPAY_VIS-
MPAY-
MXAM-
MXMC-
MXVIS-
PAY-
PSE-
SAP-
SRP-
TAO-
TOD-
TRO-
VA_ON-
VIS-
VISE-
VROVale Refeição Online
DINDinheiro
CRE-
BANRC-
DNREST-
GER_CC-
GOODC-
NUGO-
RAM-
RDREST-
REC-
RHIP-
VERDEC-
VSREST-
CARDCartão de Crédito
GER_DC-
BANRD-
GER_CT-
MEREST-
RED-
VIRESTCartão de Débito
BENVVR-
CPRCAR-
GRNCAR-
GRNCPL-
NUTCRD-
RSELE-
RSODEX-
TRE-
TVER-
VA_OFF-
VALECA-
VISAVR-
VR_SMA-
VVRESTVale Refeição
Authorizations:
apikeyAuth
path Parameters
origin
required
string
Example: value

(Required) ID da origem do pedido

header Parameters
x-api-key
string
Example: value

(Required) Token identificador do client integrador, esse token vai ser passado para a empresa integradora pela Box Delivery

Content-Type
string
Example: application/json
Authorization
string
Example: value

(Required) Token identificador do client integrador, esse token vai ser passado para a empresa integradora pela Box Delivery

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "external_id": "0c15c9dd-36d3-467e-af54-1bbf7ef91836",
  • "short_external_reference": "123456",
  • "delivery_type": "DELIVERY",
  • "marketplace_id": "123",
  • "marketplace_name": "Ifood",
  • "address": {
    },
  • "customer": {
    },
  • "delivery_datetime": "2021-01-26T18:44:20+03:00",
  • "preparation_start": "2021-01-26T18:14:20+03:00",
  • "order_created_at": "2021-01-26T18:14:20+03:00",
  • "preparation_time_in_seconds": 300,
  • "total_price": 39.5,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "external_id": "0c15c9dd-36d3-467e-af54-1bbf7ef91836",
  • "short_external_reference": "123456",
  • "address": {
    },
  • "customer": {
    },
  • "delivery_datetime": "2021-01-26T18:44:20+03:00",
  • "preparation_start": "2021-01-26T18:14:20+03:00",
  • "order_created_at": "2021-01-26T18:14:20+03:00",
  • "preparation_time_in_seconds": 300,
  • "uuid": "urn:uuid:edebf2fc-ad23-d2e2-4d62-e8da4e9acf7f",
  • "total_price": 39.5,
  • "items": [
    ]
}

Cálculo de frete

path Parameters
vehicle_type
required
integer
Example: 1

Tipo de veículo:

1 Moto, 2 Carro , 3 Bicicleta

latitude
required
string

latitude do destino

longitude
required
string

longitude do destino

header Parameters
x-api-key
string
Example: adipisicing ut dolor
Authorization
string
Example: adipisicing ut dolor

Responses

Response samples

Content type
application/json
{
  • "withReturn": {
    },
  • "withoutReturn": {
    },
  • "distance": 10598
}

Cancelamento de Pedido

Cancela um pedido

Só poderá cancelar o pedidos que estejam no status 1 = Localizando Entregador

Só poderá cancelar o pedido que estejam no status 2 = Aguardando Entregador e 3 = Entregador no Estabelecimento.

Authorizations:
apikeyAuth
path Parameters
id
required
string
header Parameters
x-api-key
string
Example: adipisicing ut dolor

(Required) Token identificador do client integrador, esse token vai ser passado para a empresa integradora pela Box Delivery

Content-Type
string
Example: application/json

Responses