Consultar pedido pelo código

Time	Status	User Agent
Retrieving recent requests…

Objetivo: Listar uma entrega específica pelo id da transportadora autorizada.

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

ID (obrigatório) - ID da entrega

Response

Pedido

Campo	Tipo	Descricao
shipment_id	string	ID da entrega (alias de external_shipment_id).
external_shipment_id	string	ID externo unico da entrega.
external_order_id	string ou number	ID externo do pedido no canal de venda.
external_label_id	string ou null	Identificador externo da etiqueta da entrega.
date_created	datetime (string)	Data/hora de criação da entrega no canal de vendas.
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.
date_cancelled	datetime (string) ou null	Data/hora de cancelamento da entrega.
internal_status	string	Status interno operacional da entrega (status_goflex).
status	string	Status da entrega traduzido para português.
substatus	string	Substatus da entrega traduzido para português.
original_status	string	Status original da integração (antes da tradução).
original_substatus	string	Substatus original da integração (antes da tradução).
date_handling	datetime (string) ou null	Data/hora em que a entrega entrou em manuseio.
date_shipped	datetime (string) ou null	Data/hora de envio/saida para entrega.
date_first_visit	datetime (string) ou null	Data/hora da primeira tentativa de entrega.
date_delivered	datetime (string) ou null	Data/hora da entrega concluida.
base_cost	number ou string	Custo base do frete.
export_type	string	Forma de exportação da entrega (ex.: automatic, api_call).
delivery_preference	string	Preferencia de entrega (ex.: residential).
integration_name	string ou null	Nome da integração/canal que originou a entrega.
label_url	string	URL da etiqueta PDF, ou not_downloaded_yet quando não houver etiqueta baixada.
receiver_address_zone	string ou null	Zona de atendimento inferida pelo CEP de entrega.
size_id	number ou null	Identificador do porte/tamanho da entrega.
size_color	string ou null	Cor associada ao tamanho da entrega.
size_abbreviation	string ou null	Sigla do tamanho da entrega.
size_weight	number ou string ou null	Peso de referencia do tamanho da entrega.
history	array de objetos	Lista de eventos do histórico da entrega.
items	array de objetos	Itens vinculados a entrega.

Cliente

Campo	Tipo	Descrição
name	string	Nome do cliente/vendedor.
fantasy_name	string ou null	Nome fantasia do cliente/vendedor.
client_data_id	number ou null	ID do registro complementar do cliente.
client_name	string	Nome final do cliente.
external_seller_id	string ou number	Identificador externo da conta no canal.
integration_name	string ou null	Nome da integração/canal associado ao pedido.
account_id	number	ID interno da conta de venda vinculada.
account_name	string ou null	Nome da conta de venda vinculada.

Endereço de Entrega

Campo	Tipo	Descricao
receiver_address_address_line	string	Logradouro do destinatário.
receiver_address_receiver_name	string	Nome do destinatário.
receiver_address_receiver_phone	string ou null	Telefone do destinatário.
receiver_address_neighborhood	string	Bairro do destinatário.
receiver_address_city	string	Cidade do destinatário.
receiver_address_zip_code	string	CEP 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_zone	string ou null	Zona de cobertura associada ao CEP de entrega.

Endereço de Coleta

Campo	Tipo	Descricao
collection_address_line	string ou null	Endereço de coleta (origem da conta).
collection_address_number	string ou null	Numero do endereço de coleta.
collection_address_neighborhood	string ou null	Bairro do endereço de coleta.
collection_address_city	string ou null	Cidade do endereço de coleta.
collection_address_state	string ou null	Estado (UF) do endereço de coleta.
collection_address_zip_code	string ou null	CEP do endereço de coleta.
collection_latitude	string ou number ou null	Latitude do ponto de coleta.
collection_longitude	string ou number ou null	Longitude do ponto de coleta.
collection_phones	string ou array ou null	Telefones do ponto de coleta (vendedor).

Itens do pedido

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

Campo	Tipo	Descrição
id	number	ID do evento de histórico.
external_shipment_id	string	ID da entrega associada ao evento.
key	string	Chave do evento (ex.: status_ready_to_ship, substatus_out_for_delivery).
value	datetime (string) ou string	Valor do evento, normalmente data/hora do marco.
sale_channel_id	number	ID do canal de venda no evento.
driver_id	number ou null	ID do motorista, quando aplicável.
name_driver	string	Nome do motorista (quando enriquecido).
doc_driver	string	Documento do motorista (quando enriquecido).
car_type_driver	string	Tipo de veiculo do motorista (quando enriquecido).
board_driver	string	Placa do veiculo do motorista (quando enriquecido).

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