Instruções

Para utilização é indispensável a API_KEY do estabelecimento. Caso não tenha, faça a solicitação através do nosso suporte.

Status dos pedidos

Nome	Descrição
EM_PREPARACAO	O pedido foi criado e está em preparação
PRONTO_PARA_RETIRADA	O pedido está disponível para retirada
AGUARDANDO_ALOCACAO	Estamos alocando esse pedido para um entregador
MOTOBOY_A_CAMINHO	Um entregador foi alocado para esse pedido e está a caminho para coletar
MOTOBOY_CHEGOU_COLETA	O entregador chegou no ponto de coleta para retirar o pedido
MOTOBOY_EM_ROTA	O entregador está em rota
MOTOBOY_CHEGOU_DESTINO	O entregador chegou no ponto de entrega e está aguardando para entregar
ENTREGUE	O entregador entregou o pedido
FINALIZADA	O estabelecimento conferiu o pedido e finalizou
CANCELADA	O estabelecimento cancelou o pedido

Consultar o valor da taxa de entrega para determinado endereço

GETintegration/get_delivery_fee/ COPY

Nome	Tipo	Valor Esperado	Descrição
api_key	STRING/REQUIRED		Token de autorização do estabelecimento
street	STRING/REQUIRED		Rua do destinatário
number	STRING/REQUIRED		Número do destinatário
neighborhood	STRING/REQUIRED		Bairro do destinatário
city	STRING/REQUIRED		Cidade do destinatário
state	STRING/REQUIRED		UF do destinatário
zip_code	STRING/REQUIRED		CEP do destinatário
method	ENUM/REQUIRED	DINHEIRO,ONLINE,CREDITO ou DEBITO	Forma de pagamento

Validação	Tipo	Retorno	Status Code
Localidade não atendida	JSON	{"success":false,"msg":"Localidade não atendida"}	422
Endereço não encontrado	JSON	{"success":false,"msg":"Endereço não encontrado"}	422
api_key não enviada	JSON	{"success":false,"msg":"Envie uma chave: api_key"}	422
api_key Inválida	JSON	{"success":false,"msg":"Por favor, envie uma chave válida"}	422
Campos incompletos	JSON	{"success":false,"msg":"Envie todos os campos obrigatórios: ..."}	422
Taxa de entrega calculada com sucesso!	JSON	{"success":true,"msg":"Valor calculado com sucesso", "lat_destination": X, "lng_destination": X, "distance": X, "delivery_fee": X}	200

Como realizar a criação de pedido para um determinado ponto

Para envio das informações utilize: content-type: form-data

POSTintegration/new_request/ COPY

Nome	Tipo	Valor Esperado	Descrição
api_key	STRING/REQUIRED		Token de autorização do estabelecimento
ifood_id	INT		Identificador do pedido (Se o pedido for do ifood)
internal_code	STRING/REQUIRED		Número de identificação interno
name	STRING/REQUIRED		Nome do destinatário
phone	STRING	(99) 99999-9999	Telefone do destinatário
value	DECIMAL/REQUIRED	0.00	Valor total do pedido
receive	DECIMAL/REQUIRED	0.00	Valor pago
method	STRING/REQUIRED	DINHEIRO,ONLINE,CREDITO ou DEBITO	Forma de pagamento
lat_destination	STRING/REQUIRED		Latitude do destinatário
lng_destination	STRING/REQUIRED		Longitude do destinatário
complement	STRING		Complemento do endereço do destinatário
instruction	STRING		Instruções de entrega

Validação	Tipo	Retorno	Status Code
Pedido não foi criado	JSON	{"success":false,"msg":"Solicitação não foi criada"}	422
Pedido não foi criado	JSON	{"success":false,"msg":"Saldo indisponível"}	422
Coordenadas inválidas	JSON	{"success":false,"msg":"latitude e longitude inválidas"}	422
api_key não enviada	JSON	{"success":false,"msg":"Envie uma chave: api_key"}	422
api_key Inválida	JSON	{"success":false,"msg":"Por favor, envie uma chave válida"}	422
Campos incompletos	JSON	{"success":false,"msg":"Por favor, envie todos os campos: ..."}	422
Pedido criado	JSON	{"success":true,"msg":"Solicitação criada com sucesso", "identifier":"6DSAHf1odz", "tracking": "https://rastreio.moovery.com.br/mapa/6DSAHf1odz", "delivery_fee": 8}	200

Para verificação após criação de um pedido

GETintegration/get_status/ COPY

Nome	Tipo	Valor Esperado	Descrição
api_key	STRING/REQUIRED		Token de autorização do estabelecimento
identifier	STRING/REQUIRED		Código de identificação do pedido

Validação	Tipo	Retorno	Status Code
Pedido não encontrado	JSON	{"success":false,"msg":"Pedido não encontrado"}	422
api_key não enviada	JSON	{"success":false,"msg":"Envie uma chave: api_key"}	422
api_key Inválida	JSON	{"success":false,"msg":"Por favor, envie uma chave válida"}	422
Campos incompletos	JSON	{"success":false,"msg":"Por favor, envie todos os campos: ..."}	422
Pedido encontrado	JSON	{"success":true,"msg":"request found successfully", "identifier":"6DSAHf1odz", "tracking": "https://rastreio.moovery.com.br/mapa/6DSAHf1odz", "status": "AGUARDANDO_ALOCACAO"}	200

POSTintegration/dispatch/ COPY

Nome	Tipo	Descrição
api_key	STRING/REQUIRED	Token de autorização do estabelecimento
identifier	STRING/REQUIRED	Código de identificação do pedido

Validação	Tipo	Retorno	Status Code
Campos vazios	JSON	{"success":false, "message":"Campo api_key/identifier não pode ser vazio", "status":422, "timestamp": Y-m-d H:i:s}	422
api_key Inválida	JSON	{"success":false,"message":"Chave de acesso inválida", "status":422, "timestamp": Y-m-d H:i:s}	422
Internal code inválido	JSON	{"success":false,"message":"Internal code não encontrado", "status":422, "timestamp": Y-m-d H:i:s}	422
Motoboy em rota	JSON	{"success":false,"message":"Motoboy já está em rota", "status":422, "timestamp": Y-m-d H:i:s}	422
Entrega sem motoboy	JSON	{"success":false,"message":"Entrega sem motoboy", "status":422, "timestamp": Y-m-d H:i:s}	422
Entrega/rota atualizada	JSON	{"success":true,"message":"Motoboy iniciou a rota","identifier" => [CÓDIGO DE IDENTIFICAÇÃO], "deliverieStatus" => "MOTOBOY_EM_ROTA", "status":200, "timestamp": Y-m-d H:i:s}	200