Listar todas as entregas de determinada transportadora

Time	Status	User Agent
Retrieving recent requests…

Objetivo: Listar entregas da transportadora autorizada, você pode filtrar por cliente, status e data de criação.

Os campos que você precisará enviar são:

Per_page (obrigatório) - Quantidade de itens por página
Page (obrigatório) - Número da página
Startdate (obrigatório) - Data início da busca ( data de criação )
Enddate (obrigatório) - Data fim da busca ( data de criação )
Status [] - Filtros de status disponíveis

Pendentes de impressão, Prontos para enviar, Entregues, Não entregues, A caminho, Cancelados

Client_ID - ID do cliente do menu Clientes
Internal_code - Código interno

Descrição dos campos na resposta

Campo	Tipo	Descrição
page	number	Pagina atual da consulta.
per_page	number	Quantidade de registros por pagina.
total	number	Total de registros encontrados.
data	array de objetos	Lista de pedidos retornados na pagina.

Pedido (objeto dentro de data[])

Campo	Tipo	Descrição
shipment_id	string	ID principal da entrega retornado pela API.
external_label_id	string ou null	ID externo da etiqueta da entrega.
date_created	datetime (string)	Data/hora de criação da entrega no canal.
shipment_settings	json string ou null	Configurações da entrega no campo settings da shipment.
client_id	number	ID interno do cliente.
user_id	number	ID do usuário vinculado ao cliente.
system_id	number ou null	ID do registro em clients_data.
name	string	Nome base do cliente.
client_data_name	string ou null	Nome vindo de tabela complementar do cliente.
fantasy_name	string ou null	Nome fantasia do cliente.
user_custom_id	string ou null	Código customizado do cliente.
client_settings	json string ou null	Configurações do cliente.
receiver_address_receiver_name	string	Nome do destinatário.
status	string	Status traduzido da entrega.
substatus	string	Substatus traduzido da entrega.
internal_status	string	Status interno (status_goflex traduzido).
date_shipped	datetime (string) ou null	Data/hora de expedição.
date_first_visit	datetime (string) ou null	Data/hora da primeira tentativa de entrega.
date_delivered	datetime (string) ou null	Data/hora de entrega concluida.
account_name	string ou null	Nome da conta.
account_id	number	ID da conta do canal de venda.
settings	json string ou null	Configurações da conta de canal.
id	number	ID interno do pedido no banco.
downloaded	number	Flag de etiqueta baixada (0 ou 1).
delivery_preference	string	Preferencia de entrega (residential/business).
created_at	datetime (string)	Data/hora de criação do registro no sistema.
updated_at	datetime (string)	Data/hora da ultima atualização do registro.
sale_channel_id	number	ID do canal de venda/integração.
external_shipment_id	string	ID externo da entrega no canal.
alternative_shipment_id	string ou null	ID alternativo da entrega (quando existir).
external_order_id	string ou number	ID externo do pedido.
external_seller_id	string ou number	ID externo do vendedor no canal.
date_cancelled	datetime (string) ou null	Data/hora de cancelamento da entrega.
last_status	string ou null	Ultimo status traduzido consolidado.
date_estimated_delivery	datetime (string) ou null	Data estimada de entrega.
is_turbo	string ou null	Indicador adicional da entrega (campo shipments_aditional_info).
ticket_id	string ou null	ID de ticket vinculado (quando existir).
size_id	number ou null	ID de tamanho/porte da entrega.
size_color	string ou null	Cor do tamanho/porte.
size_abbreviation	string ou null	Sigla do tamanho/porte.
size_weight	number ou string ou null	Peso do tamanho/porte cadastrado.
obs_status	string ou null	Concatenação de observações de status.
channel	string ou null	Nome do canal de venda (ex.: mercadolivre, shopee).
items	array de objetos	Itens da entrega.
history	array de objetos	Histórico de eventos da entrega.

Endereço de Entrega

Campo	Tipo	Descrição
receiver_address_address_line	string	Logradouro de entrega.
receiver_address_street_number	string ou null	Numero do endereço de entrega.
receiver_address_city	string	Cidade de entrega.
receiver_address_neighborhood	string	Bairro de entrega.
receiver_address_zip_code	string	CEP de entrega.
receiver_address_receiver_phone	string ou null	Telefone do destinatário.
receiver_address_latitude	string ou number ou null	Latitude do endereço de entrega.
receiver_address_longitude	string ou number ou null	Longitude do endereço de entrega.
receiver_address_comment	string ou null	Complemento/referencia de entrega.
receiver_address_state	string	UF do endereço de entrega.
receiver_address_zone	string ou null	Zona operacional associada ao CEP de entrega.

Endereço de Coleta

Campo	Tipo	Descrição
collection_address_line	string ou null	Logradouro de coleta/origem.
collection_address_neighborhood	string ou null	Bairro de coleta.
collection_address_number	string ou null	Numero do endereço de coleta.
collection_address_city	string ou null	Cidade de coleta.
collection_address_state	string ou null	UF de coleta.
collection_address_zip_code	string ou null	CEP de coleta.
collection_phones	string ou json string ou null	Telefones de coleta da conta.
collection_latitude	number ou string ou null	Latitude do endereço de coleta.
collection_longitude	number ou string ou null	Longitude do endereço de coleta.

Itens (objeto dentro de items[])

Campo	Tipo	Descrição
external_item_id	string	ID externo do item no canal.
description	string	Descrição do item.
quantity	number	Quantidade do item na entrega.
category	string ou null	Categoria do item.
dimensions	string ou null	Dimensões do item (ex.: altura x largura x comprimento, peso).

Historico (objeto dentro de history[])

Campo	Tipo	Descrição
id	number	ID do evento no histórico.
external_shipment_id	string	ID da entrega associada ao evento.
key	string	Chave do evento (ex.: status_collected, status_shipped, status_delivered).
value	datetime (string) ou string	Valor do evento (normalmente data/hora efetiva).
sale_channel_id	number	ID do canal de venda no evento.
master_id	number	ID do master associado ao registro de histórico.
latitude	string ou number ou null	Latitude registrada no evento.
longitude	string ou number ou null	Longitude registrada no evento.
distance	string ou number ou null	Distancia registrada no evento.
url_comprovante	string ou null	URL do comprovante (imagem), quando existir.
driver_id	number ou null	ID do motorista associado ao evento.
operator_id	number ou null	ID do operador que registrou o evento manual, quando existir.
romaneio_id	number ou null	ID do romaneio relacionado ao evento.
doc_driver	string ou null	Documento do motorista.
name_driver	string ou null	Nome do motorista.
receiver_name	string ou null	Nome de quem recebeu no evento de entrega, quando informado.
receiver_doc	string ou null	Documento de quem recebeu, quando informado.
receiver_grau	string ou null	Grau de relacionamento de quem recebeu (ex.: próprio, porteiro).
created_at	datetime (string) ou null	Data/hora de criação do registro de histórico.
deleted_at	datetime (string) ou null	Data/hora de exclusão lógica, quando existir.
observation_driver_name	string ou null	Observação/identificação complementar do motorista.
origin	string ou null	Origem do evento (ex.: app, manual, shopee).
geocode_location_app	string ou null	Tipo de geolocalização capturada no app.
car_type_driver	string ou null	Tipo de veiculo do motorista (quando disponível).
board_driver	string ou null	Placa do veiculo do motorista (quando disponível).

Possíveis status retornados

ID	Status	Tradução
18	collected	COLETADO
19	received	RECEBIMENTO FÍSICO
20	shipped	EM ROTA DE ENTREGA
21	delivered	ENTREGUE
22	away	AUSENTE, LOCAL FECHADO, 2 VEZES AUSENTE
23	devolution	DEVOLVIDO AO CLIENTE
24	risk_area	ÁREA DE RISCO
25	stolen	EXTRAVIADO
27	cancelled	CANCELADO
28	incorrect_address	ENDEREÇO INSUFICIENTE
29	recused	RECUSADO, DESCONHECIDO, MUDOU-SE, EX-FUNCIONÁRIO, FALECIDO
26	thefted	ROUBO / FURTO
33	in_devolution	EM PROCESSO DE DEVOLUÇÃO, SETOR DE DEVOLUÇÃO, EM ROTA DE ENTREGA/DEVOLUÇÃO
32	avaried	AVARIADO
210	prejudicted	PROBLEMA NO VEICULO
288	collect_not_performed	INSUCESSO NA COLETA
211 \| 254	not_collected	NÃO COUBE NO VEÍCULO, PROBLEMA NO ENDEREÇO DE COLETA, VENDEDOR NÃO ENTREGOU PEDIDO, PEDIDO ACIMA DA DIMENSÃO
209	other_carrier	COLETA REALIZADA POR OUTRA TRANSPORTADORA
214	confrontation	ACAREAÇÃO
34 \| 261	ready_to_ship	PRONTO PARA ENVIAR
341	affected_by_rain	AREA AFETADA PELA CHUVA
343	handling	EM MANUSEIO

200200