Easyship (Independent Publisher) (versão prévia)
O Easyship fornece um serviço poderoso para você adicionar opções de envio gratuito em todo o mundo ao seu site e funcionalidade de envio de ponta a ponta para seu armazém, ERP ou plataforma.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site | https://www.easyship.com/ |
| Política de privacidade | https://www.easyship.com/legal/privacy |
| Categorias | Gestão de empresas; Comércio |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token de Acesso à API (no formato: APIAccessToken do portador) | secureString | O Token de Acesso à API (no formato: APIAccessToken do portador) para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atualizar o estado do warehouse |
Atualize o estado do armazém de uma remessa. Disponível apenas para remessas atendidas em um dos armazéns integrados da Easyship. |
| Atualizar uma remessa |
Atualize os detalhes de uma remessa. |
| Comprar um rótulo de remessa (V1) |
Compre e recupere informações sobre uma etiqueta de remessa. |
| Criar uma remessa |
Cria e recupera as informações sobre uma remessa. |
| Excluir uma remessa (V1) |
Exclua e receba a confirmação de uma exclusão de remessa. |
| Listar todas as caixas |
Recupera uma lista de todas as caixas de correio disponíveis. |
| Listar todas as remessas |
Recupera uma lista de todas as remessas. |
| Obter categorias de itens |
Recupera uma lista de categorias de remessa e a lesma para usar a categoria. |
| Obter o status de acompanhamento |
Recupera o status de acompanhamento de uma remessa. |
| Obter pontos de verificação |
Recupera detalhes dos pontos de verificação de remessa. |
| Obter slots de retirada disponíveis (V1) |
Os slots de retirada disponíveis serão calculados para um entregador específico, no horário local e nos próximos 7 dias. Uma retirada pode ser solicitada usando a ação "Solicitar retirada". |
| Obter taxas e impostos |
Recupere uma lista de cotações de envio para uma remessa em potencial. |
| Obter uma remessa |
Obtenha os detalhes de uma remessa. |
| Solicitar uma retirada (V1) |
Quando uma retirada é criada, uma solicitação de retirada será feita diretamente para o entregador, que retornará um número de referência. O número de referência pode ser usado ao entrar em contato com o atendimento ao cliente do entregador. Um slot de retirada deve ser escolhido; os slots de retirada futuros podem ser encontrados usando a ação "Obter slots de retirada disponíveis". |
Atualizar o estado do warehouse
Atualize o estado do armazém de uma remessa. Disponível apenas para remessas atendidas em um dos armazéns integrados da Easyship.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
|
Estado do Warehouse
|
warehouse_state | string |
O estado do armazém. |
|
|
Message
|
message | string |
A mensagem. |
|
|
Número de Série
|
serial_number | string |
O número de série. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Message
|
message | array of object | |
|
ID de remessa de easyship
|
message.easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
Estado do warehouse atualizado
|
message.warehouse_state_updated | string |
O estado atualizado do warehouse. |
Atualizar uma remessa
Atualize os detalhes de uma remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | True | string |
O identificador de remessa easyship. |
|
Código do país de destino
|
destination_country_alpha2 | string |
O código do país de destino. |
|
|
Cidade de Destino
|
destination_city | string |
A cidade de destino. |
|
|
Nome do destino
|
destination_name | string |
O nome do destino. |
|
|
Endereço de destino
|
destination_address_line_1 | string |
O endereço de destino. |
|
|
Número de telefone de destino
|
destination_phone_number | string |
O número de telefone de destino. |
|
|
Description
|
description | string |
A descrição. |
|
|
Peso real
|
actual_weight | float |
O peso real. |
|
|
Altura
|
height | integer |
A altura. |
|
|
Largura
|
width | integer |
A largura. |
|
|
Length
|
length | integer |
O comprimento. |
|
|
Categoria
|
category | string |
A categoria. |
|
|
Moeda Declarada
|
declared_currency | string |
A moeda declarada. |
|
|
Valor alfandegário declarado
|
declared_customs_value | integer |
O valor alfandegário declarado. |
|
|
SKU
|
sku | string |
A SKU. |
|
|
Nome da plataforma
|
platform_name | string |
O nome da plataforma. |
|
|
Número do pedido da plataforma
|
platform_order_number | string |
O número do pedido da plataforma. |
|
|
Impostos pagos por
|
taxes_duties_paid_by | string |
Os impostos e os direitos pagos. |
|
|
É Segurado
|
is_insured | boolean |
Se está segurado. |
|
|
ID do Courier selecionada
|
selected_courier_id | string |
O identificador de entrega selecionado. |
|
|
Cep de destino
|
destination_postal_code | integer |
O código postal de destino. |
|
|
Estado de destino
|
destination_state | string |
O estado de destino. |
|
|
Linha de Endereço de Destino 2
|
destination_address_line_2 | string |
A linha de endereço de destino 2. |
|
|
Endereço de email de destino
|
destination_email_address | string |
O endereço de email de destino. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
shipment.created_at | string |
O criado em. |
|
Atualizado em
|
shipment.updated_at | string |
Quando atualizado em. |
|
ID de remessa de easyship
|
shipment.easyship_shipment_id | string |
O identificador de remessa easyship. |
|
Nome do destino
|
shipment.destination_name | string |
O nome do destino. |
|
Endereço de destino
|
shipment.destination_address_line_1 | string |
O endereço de destino. |
|
Linha de Endereço de Destino 2
|
shipment.destination_address_line_2 | string |
A linha de endereço de destino 2. |
|
Cidade de Destino
|
shipment.destination_city | string |
A cidade de destino. |
|
Estado de destino
|
shipment.destination_state | string |
O estado de destino. |
|
Cep de destino
|
shipment.destination_postal_code | string |
O código postal de destino. |
|
Número de telefone de destino
|
shipment.destination_phone_number | string |
O número de telefone de destino. |
|
Endereço de email de destino
|
shipment.destination_email_address | string |
O endereço de email de destino. |
|
Nome da plataforma
|
shipment.platform_name | string |
O nome da plataforma. |
|
Número do pedido da plataforma
|
shipment.platform_order_number | string |
O número do pedido da plataforma. |
|
Valor total da alfândega
|
shipment.total_customs_value | float |
O valor total da alfândega. |
|
Peso real total
|
shipment.total_actual_weight | float |
O peso real total. |
|
Peso Dimensional Total
|
shipment.total_dimensional_weight | float |
O peso dimensional total. |
|
Peso Volumetrico Total
|
shipment.total_volumetric_weight | float |
O peso volumetrico total. |
|
É Segurado
|
shipment.is_insured | boolean |
Se está segurado. |
|
Moeda
|
shipment.currency | string |
A moeda. |
|
Nome
|
shipment.origin_country.name | string |
O nome. |
|
Código do país
|
shipment.origin_country.alpha2 | string |
O código do país. |
|
Nome
|
shipment.destination_country.name | string |
O nome. |
|
Código do país
|
shipment.destination_country.alpha2 | string |
O código do país. |
|
Itens
|
shipment.items | array of object | |
|
ID
|
shipment.items.id | string |
O identificador exclusivo. |
|
Description
|
shipment.items.description | string |
A descrição. |
|
SKU
|
shipment.items.sku | string |
A SKU. |
|
Largura
|
shipment.items.width | integer |
A largura. |
|
Length
|
shipment.items.length | integer |
O comprimento. |
|
Altura
|
shipment.items.height | integer |
A altura. |
|
Peso real
|
shipment.items.actual_weight | float |
O peso real. |
|
Peso Dimensional
|
shipment.items.dimensional_weight | float |
O peso dimensional. |
|
Peso volumétrica
|
shipment.items.volumetric_weight | float |
O peso columétrico. |
|
Valor alfandegário declarado
|
shipment.items.declared_customs_value | integer |
O valor alfandegário declarado. |
|
Moeda Declarada
|
shipment.items.declared_currency | string |
A moeda declarada. |
|
Valor alfandegário de origem
|
shipment.items.origin_customs_value | float |
O valor alfandegário de origem. |
|
Moeda de origem
|
shipment.items.origin_currency | string |
A moeda de origem. |
|
Categoria
|
shipment.items.category | string |
A categoria. |
|
Nome
|
shipment.box.name | string |
O nome. |
|
Length
|
shipment.box.length | integer |
O comprimento. |
|
Largura
|
shipment.box.width | integer |
A largura. |
|
Altura
|
shipment.box.height | integer |
A altura. |
|
ID
|
shipment.selected_courier.id | string |
O identificador exclusivo. |
|
Nome
|
shipment.selected_courier.name | string |
O nome. |
|
Tempo mínimo de entrega
|
shipment.selected_courier.min_delivery_time | integer |
O tempo mínimo de entrega. |
|
Tempo máximo de entrega
|
shipment.selected_courier.max_delivery_time | integer |
O tempo máximo de entrega. |
|
Encargo de remessa
|
shipment.selected_courier.shipment_charge | float |
A carga de remessa. |
|
Sobretaxa de combustível
|
shipment.selected_courier.fuel_surcharge | float |
A sobretaxa de combustível. |
|
Sobretaxa de área remota
|
shipment.selected_courier.remote_area_surcharge | integer |
A sobretaxa de área remota. |
|
Total de encargos de remessa
|
shipment.selected_courier.shipment_charge_total | float |
O total da carga de remessa. |
|
Taxa de manipulação de armazém
|
shipment.selected_courier.warehouse_handling_fee | integer |
A taxa de manipulação do armazém. |
|
Taxa de Seguro
|
shipment.selected_courier.insurance_fee | integer |
A taxa do seguro. |
|
Importar encargos fiscais
|
shipment.selected_courier.import_tax_charge | integer |
A cobrança do imposto de importação. |
|
Importar encargos de direitos
|
shipment.selected_courier.import_duty_charge | integer |
A cobrança do imposto de importação. |
|
Taxa de manipulação de DDP
|
shipment.selected_courier.ddp_handling_fee | integer |
A taxa de tratamento de DDP. |
|
Encargo Total
|
shipment.selected_courier.total_charge | float |
A carga total. |
|
Está acima do limite
|
shipment.selected_courier.is_above_threshold | boolean |
Se está acima do limite. |
|
Incoterms eficazes
|
shipment.selected_courier.effective_incoterms | string |
Os incoterms efetivos. |
|
Imposto de Importação Estimado
|
shipment.selected_courier.estimated_import_tax | integer |
A estimativa de imposto de importação. |
|
Imposto de Importação Estimado
|
shipment.selected_courier.estimated_import_duty | integer |
O direito de importação estimado. |
|
Courier faz a retirada
|
shipment.selected_courier.courier_does_pickup | boolean |
Se o mensageiro faz a retirada. |
|
Courier Dropoff URL
|
shipment.selected_courier.courier_dropoff_url | string |
O endereço da URL do entregador. |
|
Comentários do Courier
|
shipment.selected_courier.courier_remarks | string |
O correio comenta. |
|
Destinatário de Pagamento
|
shipment.selected_courier.payment_recipient | string |
O destinatário do pagamento. |
|
Taxas
|
shipment.rates | array of object | |
|
Courier ID
|
shipment.rates.courier_id | string |
O identificador do correio. |
|
Nome do Mensageiro
|
shipment.rates.courier_name | string |
O nome do mensageiro. |
|
Tempo mínimo de entrega
|
shipment.rates.min_delivery_time | integer |
O tempo mínimo de entrega. |
|
Tempo máximo de entrega
|
shipment.rates.max_delivery_time | integer |
O tempo máximo de entrega. |
|
Valor para classificação de dinheiro
|
shipment.rates.value_for_money_rank | integer |
O valor da classificação de dinheiro. |
|
Classificação de Tempo de Entrega
|
shipment.rates.delivery_time_rank | integer |
A classificação de tempo de entrega. |
|
Encargo de remessa
|
shipment.rates.shipment_charge | float |
A carga de remessa. |
|
Sobretaxa de combustível
|
shipment.rates.fuel_surcharge | float |
A sobretaxa de combustível. |
|
Sobretaxa de área remota
|
shipment.rates.remote_area_surcharge | integer |
A sobretaxa de área remota. |
|
Total de encargos de remessa
|
shipment.rates.shipment_charge_total | float |
O total da carga de remessa. |
|
Taxa de manipulação de armazém
|
shipment.rates.warehouse_handling_fee | integer |
A taxa de manipulação do armazém. |
|
Taxa de Seguro
|
shipment.rates.insurance_fee | integer |
A taxa do seguro. |
|
Taxa de manipulação de DDP
|
shipment.rates.ddp_handling_fee | integer |
A taxa de tratamento de DDP. |
|
Importar encargos fiscais
|
shipment.rates.import_tax_charge | integer |
A alteração do imposto de importação. |
|
Importar encargos de direitos
|
shipment.rates.import_duty_charge | integer |
A cobrança do imposto de importação. |
|
Encargo Total
|
shipment.rates.total_charge | float |
A carga total. |
|
Está acima do limite
|
shipment.rates.is_above_threshold | boolean |
Se está acima do limite. |
|
Incoterms eficazes
|
shipment.rates.effective_incoterms | string |
Os incoterms efetivos. |
|
Imposto de Importação Estimado
|
shipment.rates.estimated_import_tax | integer |
O imposto de importação estimado. |
|
Imposto de Importação Estimado
|
shipment.rates.estimated_import_duty | integer |
O direito de importação estimado. |
|
Courier faz a retirada
|
shipment.rates.courier_does_pickup | boolean |
Se o mensageiro faz a retirada. |
|
Courier Dropoff URL
|
shipment.rates.courier_dropoff_url | string |
O endereço da URL do entregador. |
|
Classificação de acompanhamento
|
shipment.rates.tracking_rating | integer |
A classificação de acompanhamento. |
|
Classificação de easyship
|
shipment.rates.easyship_rating | float |
A classificação easyship. |
|
Comentários do Courier
|
shipment.rates.courier_remarks | string |
O correio comenta. |
|
Destinatário de Pagamento
|
shipment.rates.payment_recipient | string |
O destinatário do pagamento. |
Comprar um rótulo de remessa (V1)
Compre e recupere informações sobre uma etiqueta de remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
|
Courier ID
|
courier_id | string |
O identificador exclusivo do correio. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Message
|
message | string |
A mensagem. |
|
Errors
|
errors | array of |
Os erros. |
|
Custo Total
|
total_cost | integer |
O custo total. |
|
Saldo Disponível
|
available_balance | integer |
O saldo disponível. |
|
Rótulos
|
labels | array of object | |
|
ID de remessa de easyship
|
labels.easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
Estado do rótulo
|
labels.label_state | string |
O estado do rótulo. |
|
URL do rótulo
|
labels.label_url | string |
O endereço de URL do rótulo. |
|
Situação
|
labels.status | string |
O status. |
|
Número de acompanhamento
|
labels.tracking_number | string |
O número de acompanhamento. |
|
URL da Página de Acompanhamento
|
labels.tracking_page_url | string |
O endereço da URL da página de acompanhamento. |
Criar uma remessa
Cria e recupera as informações sobre uma remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Endereço
|
line_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
line_2 | string |
A linha de endereço 2. |
|
|
Estado
|
state | string |
O estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Código postal
|
postal_code | string |
O código postal. |
|
|
Código do país
|
country_alpha2 | string |
O código do país. |
|
|
Nome do contato
|
contact_name | string |
O nome do contato. |
|
|
Nome da Empresa
|
company_name | string |
O nome da empresa. |
|
|
Telefone de contato
|
contact_phone | string |
O número de telefone do contato. |
|
|
Email de contato
|
contact_email | string |
O endereço de email de contato. |
|
|
Endereço
|
line_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
line_2 | string |
A linha de endereço 2. |
|
|
Estado
|
state | string |
O estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Código postal
|
postal_code | string |
O código postal. |
|
|
Código do país
|
country_alpha2 | string |
O código do país. |
|
|
Nome do contato
|
contact_name | string |
O nome do contato. |
|
|
Nome da Empresa
|
company_name | string |
O nome da empresa. |
|
|
Telefone de contato
|
contact_phone | string |
O número de telefone do contato. |
|
|
Email de contato
|
contact_email | string |
O endereço de email de contato. |
|
|
Endereço
|
line_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
line_2 | string |
A linha de endereço 2. |
|
|
Estado
|
state | string |
O estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Código postal
|
postal_code | string |
O código postal. |
|
|
Código do país
|
country_alpha2 | string |
O código do país. |
|
|
Nome do contato
|
contact_name | string |
O nome do contato. |
|
|
Nome da Empresa
|
company_name | string |
O nome da empresa. |
|
|
Telefone de contato
|
contact_phone | string |
O número de telefone do contato. |
|
|
Email de contato
|
contact_email | string |
O endereço de email de contato. |
|
|
Endereço
|
line_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
line_2 | string |
A linha de endereço 2. |
|
|
Estado
|
state | string |
O estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Código postal
|
postal_code | string |
O código postal. |
|
|
Código do país
|
country_alpha2 | string |
O código do país. |
|
|
Nome do contato
|
contact_name | string |
O nome do contato. |
|
|
Nome da Empresa
|
company_name | string |
O nome da empresa. |
|
|
Telefone de contato
|
contact_phone | string |
O número de telefone do contato. |
|
|
Email de contato
|
contact_email | string |
O endereço de email de contato. |
|
|
Definir como residencial
|
set_as_residential | boolean |
Se definido como residencial. |
|
|
ID do imposto consignado
|
consignee_tax_id | string |
O identificador de imposto consignado. |
|
|
Referência de EEI
|
eei_reference | string |
A referência de EEI. |
|
|
Incoterms
|
incoterms | string |
Os incoterms. |
|
|
É Segurado
|
is_insured | boolean |
Se está segurado. |
|
|
Valor do Segurado
|
insured_amount | integer |
O valor do segurado. |
|
|
Moeda segurada
|
insured_currency | string |
A moeda segurada. |
|
|
Nome da plataforma
|
platform_name | string |
O nome da plataforma. |
|
|
Número do pedido da plataforma
|
platform_order_number | string |
O número do pedido da plataforma. |
|
|
Lista de Marcas de Pedidos
|
order_tag_list | array of string |
A lista de marcas de pedidos. |
|
|
Anotações do Vendedor
|
seller_notes | string |
As anotações do vendedor. |
|
|
Notas do comprador
|
buyer_notes | string |
As anotações do comprador. |
|
|
ID do Courier selecionada
|
selected_courier_id | string |
O identificador de entrega selecionado. |
|
|
Permitir Fallback do Courier
|
allow_courier_fallback | boolean |
Se permitir fallback de entrega. |
|
|
Aplicar regras de envio
|
apply_shipping_rules | boolean |
Se as regras de envio foram aplicadas. |
|
|
Weight
|
weight | string |
O peso. |
|
|
Dimensões
|
dimensions | string |
As dimensões. |
|
|
Formato
|
format | string |
O formato. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Fatura Comercial
|
commercial_invoice | string |
A fatura comercial. |
|
|
Deslizamento de embalagem
|
packing_slip | string |
O deslizamento de embalagem. |
|
|
Comprar Rótulo
|
buy_label | boolean |
Se o rótulo é comprado. |
|
|
Comprar rótulo síncrono
|
buy_label_synchronous | boolean |
Se o rótulo é comprado de forma síncrona. |
|
|
Peso real total
|
total_actual_weight | float |
O peso real total. |
|
|
Slug
|
slug | string | ||
|
Length
|
length | integer |
O comprimento. |
|
|
Largura
|
width | integer |
A largura. |
|
|
Altura
|
height | integer |
A altura. |
|
|
Description
|
description | string |
A descrição. |
|
|
Categoria
|
category | string |
A categoria. |
|
|
SKU
|
sku | string |
A SKU. |
|
|
Quantidade
|
quantity | integer |
A quantidade. |
|
|
Length
|
length | string |
O comprimento. |
|
|
Largura
|
width | string |
A largura. |
|
|
Altura
|
height | string |
A altura. |
|
|
Peso real
|
actual_weight | integer |
O peso real. |
|
|
Moeda Declarada
|
declared_currency | string |
A moeda declarada. |
|
|
Valor alfandegário declarado
|
declared_customs_value | integer |
O valor alfandegário declarado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
O status. |
|
Errors
|
errors | array of |
Os erros. |
|
ID de remessa de easyship
|
shipment.easyship_shipment_id | string |
O identificador de remessa easyship. |
|
Criado em
|
shipment.created_at | string |
O criado em. |
|
Atualizado em
|
shipment.updated_at | string |
Quando atualizado em. |
|
Rótulo pago em
|
shipment.label_paid_at | string |
O rótulo pago em. |
|
Rótulo gerado em
|
shipment.label_generated_at | string |
O rótulo gerado em. |
|
Pedido criado em
|
shipment.order_created_at | string |
A ordem criada em. |
|
Endereço
|
shipment.origin_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipment.origin_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipment.origin_address.state | string |
O estado. |
|
City
|
shipment.origin_address.city | string |
A cidade. |
|
Código postal
|
shipment.origin_address.postal_code | string |
O código postal. |
|
Código do país
|
shipment.origin_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipment.origin_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipment.origin_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipment.origin_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipment.origin_address.contact_email | string |
O endereço de email de contato. |
|
Endereço
|
shipment.sender_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipment.sender_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipment.sender_address.state | string |
O estado. |
|
City
|
shipment.sender_address.city | string |
A cidade. |
|
Código postal
|
shipment.sender_address.postal_code | string |
O código postal. |
|
Código do país
|
shipment.sender_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipment.sender_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipment.sender_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipment.sender_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipment.sender_address.contact_email | string |
O endereço de email de contato. |
|
Endereço
|
shipment.return_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipment.return_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipment.return_address.state | string |
O estado. |
|
City
|
shipment.return_address.city | string |
A cidade. |
|
Código postal
|
shipment.return_address.postal_code | string |
O código postal. |
|
Código do país
|
shipment.return_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipment.return_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipment.return_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipment.return_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipment.return_address.contact_email | string |
O endereço de email de contato. |
|
Endereço
|
shipment.destination_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipment.destination_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipment.destination_address.state | string |
O estado. |
|
City
|
shipment.destination_address.city | string |
A cidade. |
|
Código postal
|
shipment.destination_address.postal_code | string |
O código postal. |
|
Código do país
|
shipment.destination_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipment.destination_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipment.destination_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipment.destination_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipment.destination_address.contact_email | string |
O endereço de email de contato. |
|
Nome da plataforma
|
shipment.order_data.platform_name | string |
O nome da plataforma. |
|
Número do pedido da plataforma
|
shipment.order_data.platform_order_number | string |
O número do pedido da plataforma. |
|
Lista de Marcas de Pedidos
|
shipment.order_data.order_tag_list | array of string |
A lista de marcas de pedidos. |
|
Anotações do Vendedor
|
shipment.order_data.seller_notes | string |
As anotações do vendedor. |
|
Notas do comprador
|
shipment.order_data.buyer_notes | string |
As anotações do comprador. |
|
Definir como residencial
|
shipment.set_as_residential | boolean |
Se definido como residencial. |
|
ID do imposto consignado
|
shipment.consignee_tax_id | string |
O identificador de imposto consignado. |
|
Referência de EEI
|
shipment.eei_reference | string |
A referência de EEI. |
|
Incoterms
|
shipment.incoterms | string |
Os incoterms. |
|
É Segurado
|
shipment.insurance.is_insured | boolean |
Se está segurado. |
|
Valor do Segurado
|
shipment.insurance.insured_amount | integer |
O valor do segurado. |
|
Moeda segurada
|
shipment.insurance.insured_currency | string |
A moeda segurada. |
|
Contagem de pacotes
|
shipment.parcels_count | integer |
A contagem de pacotes. |
|
Parcelas
|
shipment.parcels | array of object | |
|
Peso real total
|
shipment.parcels.total_actual_weight | float |
O peso real total. |
|
Valor total da alfândega
|
shipment.parcels.total_customs_value | float |
O valor total da alfândega. |
|
Peso Dimensional Total
|
shipment.parcels.total_dimensional_weight | float |
O peso dimensional total. |
|
Peso Volumetrico Total
|
shipment.parcels.total_volumetric_weight | float |
O peso volumetrico total. |
|
ID
|
shipment.parcels.box.id | string |
O identificador exclusivo. |
|
Slug
|
shipment.parcels.box.slug | string |
A lesma. |
|
Length
|
shipment.parcels.box.length | integer |
O comprimento. |
|
Largura
|
shipment.parcels.box.width | integer |
A largura. |
|
Altura
|
shipment.parcels.box.height | integer |
A altura. |
|
items
|
shipment.parcels.items | array of object | |
|
Description
|
shipment.parcels.items.description | string |
A descrição. |
|
Categoria
|
shipment.parcels.items.category | string |
A categoria. |
|
SKU
|
shipment.parcels.items.sku | string |
A SKU. |
|
Quantidade
|
shipment.parcels.items.quantity | integer |
A quantidade. |
|
Peso real
|
shipment.parcels.items.actual_weight | integer |
O peso real. |
|
Peso Dimensional
|
shipment.parcels.items.dimensional_weight | integer |
O peso dimensional. |
|
Peso volumétrica
|
shipment.parcels.items.volumetric_weight | integer |
O peso volumetrico. |
|
Moeda de origem
|
shipment.parcels.items.origin_currency | string |
A moeda de origem. |
|
Valor alfandegário de origem
|
shipment.parcels.items.origin_customs_value | integer |
O valor alfandegário de origem. |
|
Moeda Declarada
|
shipment.parcels.items.declared_currency | string |
A moeda declarada. |
|
Valor alfandegário declarado
|
shipment.parcels.items.declared_customs_value | integer |
O valor alfandegário declarado. |
|
Length
|
shipment.parcels.items.dimensions.length | integer |
O comprimento. |
|
Largura
|
shipment.parcels.items.dimensions.width | integer |
A largura. |
|
Altura
|
shipment.parcels.items.dimensions.height | integer |
A altura. |
|
Valor total da alfândega
|
shipment.total_customs_value | float |
O valor total da alfândega. |
|
Peso real total
|
shipment.total_actual_weight | float |
O peso real total. |
|
Peso Dimensional Total
|
shipment.total_dimensional_weight | float |
O peso dimensional total. |
|
Peso Volumetrico Total
|
shipment.total_volumetric_weight | float |
O peso volumetrico total. |
|
Estado de remessa
|
shipment.shipment_state | string |
O estado de remessa. |
|
Estado de retirada
|
shipment.pickup_state | string |
O estado de retirada. |
|
Estado de entrega
|
shipment.delivery_state | string |
O estado de entrega. |
|
Estado do rótulo
|
shipment.label_state | string |
O estado do rótulo. |
|
Estado do Warehouse
|
shipment.warehouse_state | string |
O estado do armazém. |
|
Acompanhamentos
|
shipment.trackings | array of object | |
|
Número de acompanhamento
|
shipment.trackings.tracking_number | string |
O número de acompanhamento. |
|
Número de acompanhamento local
|
shipment.trackings.local_tracking_number | string |
O número de acompanhamento local. |
|
Número de acompanhamento alternativo
|
shipment.trackings.alternate_tracking_number | string |
O número de acompanhamento alternativo. |
|
Número da Perna
|
shipment.trackings.leg_number | integer |
O número da perna. |
|
Manipulador
|
shipment.trackings.handler | string |
O manipulador. |
|
Estado de acompanhamento
|
shipment.trackings.tracking_state | string |
O estado de acompanhamento. |
|
URL da Página de Acompanhamento
|
shipment.tracking_page_url | string |
A URL da página de acompanhamento. |
|
Envio de documentos
|
shipment.shipping_documents | array of object | |
|
Categoria
|
shipment.shipping_documents.category | string |
A categoria. |
|
Obrigatório
|
shipment.shipping_documents.required | boolean |
Se necessário. |
|
Tamanho da Página
|
shipment.shipping_documents.page_size | string |
O tamanho da página. |
|
Formato
|
shipment.shipping_documents.format | string |
O formato. |
|
Cadeias de caracteres codificadas em Base64
|
shipment.shipping_documents.base64_encoded_strings | array of string |
As cadeias de caracteres codificadas em Base64. |
|
URL
|
shipment.shipping_documents.url | string |
O endereço da URL. |
|
Moeda
|
shipment.currency | string |
A moeda. |
|
ID
|
shipment.selected_courier.id | string |
O identificador exclusivo. |
|
Taxas
|
shipment.rates | array of object | |
|
Courier ID
|
shipment.rates.courier_id | string |
O identificador do correio. |
|
Nome do Mensageiro
|
shipment.rates.courier_name | string |
O nome do mensageiro. |
|
Tempo mínimo de entrega
|
shipment.rates.min_delivery_time | integer |
O tempo mínimo de entrega. |
|
Tempo máximo de entrega
|
shipment.rates.max_delivery_time | integer |
O tempo máximo de entrega. |
|
Valor para classificação de dinheiro
|
shipment.rates.value_for_money_rank | integer |
O valor da classificação de dinheiro. |
|
Classificação de Tempo de Entrega
|
shipment.rates.delivery_time_rank | integer |
A classificação de tempo de entrega. |
|
Encargo de remessa
|
shipment.rates.shipment_charge | float |
A carga de remessa. |
|
Sobretaxa de combustível
|
shipment.rates.fuel_surcharge | float |
A sobretaxa de combustível. |
|
Sobretaxa de área remota
|
shipment.rates.remote_area_surcharge | integer |
A sobretaxa de área remota. |
|
Sobretaxa superdimensionada
|
shipment.rates.oversized_surcharge | integer |
A sobretaxa enorme. |
|
Sobretaxa de serviços adicionais
|
shipment.rates.additional_services_surcharge | integer |
A sobretaxa de serviços adicionais. |
|
Taxa completa residencial
|
shipment.rates.residential_full_fee | integer |
A taxa total residencial. |
|
Taxa com desconto residencial
|
shipment.rates.residential_discounted_fee | integer |
A taxa de desconto residencial. |
|
Total de encargos de remessa
|
shipment.rates.shipment_charge_total | float |
O total da carga de remessa. |
|
Taxa de manipulação de armazém
|
shipment.rates.warehouse_handling_fee | integer |
A taxa de manipulação do armazém. |
|
Taxa de Seguro
|
shipment.rates.insurance_fee | integer |
A taxa do seguro. |
|
Imposto sobre vendas
|
shipment.rates.sales_tax | integer |
O imposto sobre vendas. |
|
Imposto sobre vendas provincial
|
shipment.rates.provincial_sales_tax | integer |
O imposto sobre vendas provincial. |
|
Taxa de manipulação de DDP
|
shipment.rates.ddp_handling_fee | integer |
A taxa de tratamento de DDP. |
|
Importar encargos fiscais
|
shipment.rates.import_tax_charge | integer |
A alteração do imposto de importação. |
|
Importar encargos de direitos
|
shipment.rates.import_duty_charge | integer |
A cobrança do imposto de importação. |
|
Encargo Total
|
shipment.rates.total_charge | float |
A carga total. |
|
Está acima do limite
|
shipment.rates.is_above_threshold | boolean |
Se está acima do limite. |
|
Incoterms
|
shipment.rates.incoterms | string |
Os incoterms. |
|
Imposto de Importação Estimado
|
shipment.rates.estimated_import_tax | integer |
O imposto de importação estimado. |
|
Imposto de Importação Estimado
|
shipment.rates.estimated_import_duty | integer |
O direito de importação estimado. |
|
Opções de Entrega Disponíveis
|
shipment.rates.available_handover_options | string |
As opções de entrega disponíveis. |
|
Classificação de acompanhamento
|
shipment.rates.tracking_rating | integer |
A classificação de acompanhamento. |
|
Classificação de easyship
|
shipment.rates.easyship_rating | integer |
A classificação easyship. |
|
Comentários do Courier
|
shipment.rates.courier_remarks | string |
O correio comenta. |
|
Destinatário de Pagamento
|
shipment.rates.payment_recipient | string |
O destinatário do pagamento. |
|
Code
|
shipment.rates.discount.code | string |
O código. |
|
Quantidade
|
shipment.rates.discount.amount | integer |
O valor. |
|
Expira em
|
shipment.rates.discount.expires_at | string |
O expira em. |
|
Porcentagem
|
shipment.rates.discount.percentage | string |
A porcentagem. |
|
Incoterms eficazes
|
shipment.rates.effective_incoterms | string |
Os incoterms efetivos. |
Excluir uma remessa (V1)
Exclua e receba a confirmação de uma exclusão de remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | True | string |
O identificador de remessa easyship. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | string |
O status. |
Listar todas as caixas
Recupera uma lista de todas as caixas de correio disponíveis.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Caixas
|
boxes | array of object | |
|
ID
|
boxes.id | string |
O identificador exclusivo. |
|
Nome do guarda-chuva do Courier
|
boxes.courier_umbrella_name | string |
O nome do guarda-chuva. |
|
Nome
|
boxes.name | string |
O nome. |
|
Slug
|
boxes.slug | string |
A lesma. |
|
Comprimento externo
|
boxes.outer_length | float |
O comprimento externo. |
|
Largura Externa
|
boxes.outer_width | float |
A largura externa. |
|
Altura Externa
|
boxes.outer_height | float |
A altura externa. |
|
Weight
|
boxes.weight | float |
O peso. |
Listar todas as remessas
Recupera uma lista de todas as remessas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
|
Número do pedido da plataforma
|
platform_order_number | string |
O número do pedido da plataforma. |
|
|
Página
|
page | integer |
A página. |
|
|
Por Página
|
per_page | integer |
O número por página. |
|
|
Criado a partir de
|
created_at_from | string |
O criado a partir de. |
|
|
Criado em
|
created_at_to | string |
O criado em. |
|
|
Confirmado em de
|
confirmed_at_from | string |
O confirmado a partir de. |
|
|
Confirmado em para
|
confirm_at_to | string |
O confirmado em. |
|
|
Gerar rótulo em de
|
label_generated_at_from | string |
O rótulo é gerado a partir do. |
|
|
Rótulo gerado em
|
label_generated_at_to | string |
O rótulo gerado em. |
|
|
Estado de remessa
|
shipment_state | string |
O estado de remessa. |
|
|
Estado de retirada
|
pickup_state | string |
O estado de retirada. |
|
|
Estado de entrega
|
delivery_state | string |
O estado de entrega. |
|
|
Estado do rótulo
|
label_state | string |
O estado do rótulo. |
|
|
Estado do Warehouse
|
warehouse_state | string |
O estado do armazém. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Transferências
|
shipments | array of object | |
|
ID de remessa de easyship
|
shipments.easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
Criado em
|
shipments.created_at | string |
O criado em. |
|
Atualizado em
|
shipments.updated_at | string |
O atualizado em. |
|
Rótulo pago em
|
shipments.label_paid_at | string |
O rótulo pago em. |
|
Rótulo gerado em
|
shipments.label_generated_at | string |
O gerado em. |
|
Pedido criado em
|
shipments.order_created_at | string |
A ordem criada em. |
|
Endereço
|
shipments.origin_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipments.origin_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipments.origin_address.state | string |
O estado. |
|
City
|
shipments.origin_address.city | string |
A cidade. |
|
Código postal
|
shipments.origin_address.postal_code | string |
O código postal. |
|
Código do país
|
shipments.origin_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipments.origin_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipments.origin_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipments.origin_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipments.origin_address.contact_email | string |
O endereço de email de contato. |
|
Endereço
|
shipments.sender_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipments.sender_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipments.sender_address.state | string |
O estado. |
|
City
|
shipments.sender_address.city | string |
A cidade. |
|
Código postal
|
shipments.sender_address.postal_code | string |
O código postal. |
|
Código do país
|
shipments.sender_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipments.sender_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipments.sender_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipments.sender_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipments.sender_address.contact_email | string |
O endereço de email de contato. |
|
Endereço
|
shipments.return_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipments.return_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipments.return_address.state | string |
O estado. |
|
City
|
shipments.return_address.city | string |
A cidade. |
|
Código postal
|
shipments.return_address.postal_code | string |
O código postal. |
|
Código do país
|
shipments.return_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipments.return_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipments.return_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipments.return_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipments.return_address.contact_email | string |
O endereço de email de contato. |
|
Endereço
|
shipments.destination_address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
shipments.destination_address.line_2 | string |
A linha de endereço 2. |
|
Estado
|
shipments.destination_address.state | string |
O estado. |
|
City
|
shipments.destination_address.city | string |
A cidade. |
|
Código postal
|
shipments.destination_address.postal_code | string |
O código postal. |
|
Código do país
|
shipments.destination_address.country_alpha2 | string |
O código do país. |
|
Nome do contato
|
shipments.destination_address.contact_name | string |
O nome do contato. |
|
Nome da Empresa
|
shipments.destination_address.company_name | string |
O nome da empresa. |
|
Telefone de contato
|
shipments.destination_address.contact_phone | string |
O número de telefone do contato. |
|
Email de contato
|
shipments.destination_address.contact_email | string |
O endereço de email de contato. |
|
Nome da plataforma
|
shipments.order_data.platform_name | string |
O nome da plataforma. |
|
Número do pedido da plataforma
|
shipments.order_data.platform_order_number | string |
O número do pedido da plataforma. |
|
Lista de Marcas de Pedidos
|
shipments.order_data.order_tag_list | array of string |
A lista de marcas de pedidos |
|
Anotações do Vendedor
|
shipments.order_data.seller_notes | string |
As anotações do vendedor. |
|
Notas do comprador
|
shipments.order_data.buyer_notes | string |
As anotações do comprador. |
|
Definir como residencial
|
shipments.set_as_residential | boolean |
Se definido como residencial. |
|
ID do imposto consignado
|
shipments.consignee_tax_id | string |
O identificador de imposto consignado. |
|
Referência de EEI
|
shipments.eei_reference | string |
A referência de EEI. |
|
Incoterms
|
shipments.incoterms | string |
Os incoterms. |
|
É Segurado
|
shipments.insurance.is_insured | boolean |
Se está segurado. |
|
Valor do Segurado
|
shipments.insurance.insured_amount | integer |
O valor do segurado. |
|
Moeda segurada
|
shipments.insurance.insured_currency | string |
A moeda segurada. |
|
Parcelas
|
shipments.parcels | array of object | |
|
Peso real total
|
shipments.parcels.total_actual_weight | float |
O peso real total. |
|
Valor total da alfândega
|
shipments.parcels.total_customs_value | float |
O valor total da alfândega. |
|
Peso Dimensional Total
|
shipments.parcels.total_dimensional_weight | float |
O peso dimensional total. |
|
Peso Volumetrico Total
|
shipments.parcels.total_volumetric_weight | float |
O peso volumetrico total. |
|
ID
|
shipments.parcels.box.id | string |
O identificador exclusivo. |
|
Nome do guarda-chuva do Courier
|
shipments.parcels.box.courier_umbrella_name | string |
O nome do guarda-chuva. |
|
Nome
|
shipments.parcels.box.name | string |
O nome. |
|
Slug
|
shipments.parcels.box.slug | string |
A lesma. |
|
Comprimento externo
|
shipments.parcels.box.outer_length | float |
O comprimento externo. |
|
Largura Externa
|
shipments.parcels.box.outer_width | float |
A largura externa. |
|
Altura Externa
|
shipments.parcels.box.outer_height | float |
A altura externa. |
|
Weight
|
shipments.parcels.box.weight | integer |
O peso. |
|
Itens
|
shipments.parcels.items | array of object | |
|
Description
|
shipments.parcels.items.description | string |
A descrição. |
|
Categoria
|
shipments.parcels.items.category | string |
A categoria. |
|
SKU
|
shipments.parcels.items.sku | string |
A SKU. |
|
Quantidade
|
shipments.parcels.items.quantity | integer |
A quantidade. |
|
Peso real
|
shipments.parcels.items.actual_weight | integer |
O peso real. |
|
Peso Dimensional
|
shipments.parcels.items.dimensional_weight | integer |
O peso dimensional. |
|
Peso volumétrica
|
shipments.parcels.items.volumetric_weight | integer |
O peso volumetrico. |
|
Moeda de origem
|
shipments.parcels.items.origin_currency | string |
A moeda de origem. |
|
Valor alfandegário de origem
|
shipments.parcels.items.origin_customs_value | integer |
O valor alfandegário de origem. |
|
Moeda Declarada
|
shipments.parcels.items.declared_currency | string |
A moeda declarada. |
|
Valor alfandegário declarado
|
shipments.parcels.items.declared_customs_value | integer |
O valor alfandegário declarado. |
|
Length
|
shipments.parcels.items.dimensions.length | integer |
O comprimento. |
|
Largura
|
shipments.parcels.items.dimensions.width | integer |
A largura. |
|
Altura
|
shipments.parcels.items.dimensions.height | integer |
A altura. |
|
Valor total da alfândega
|
shipments.total_customs_value | float |
O valor total da alfândega. |
|
Peso real total
|
shipments.total_actual_weight | float |
O peso real total. |
|
Peso Dimensional Total
|
shipments.total_dimensional_weight | float |
O peso dimensional total. |
|
Peso Volumetrico Total
|
shipments.total_volumetric_weight | float |
O peso volumetrico total. |
|
Estado de remessa
|
shipments.shipment_state | string |
O estado de remessa. |
|
Estado de retirada
|
shipments.pickup_state | string |
O estado de retirada. |
|
Estado de entrega
|
shipments.delivery_state | string |
O estado de entrega. |
|
Estado do rótulo
|
shipments.label_state | string |
O estado do rótulo. |
|
Estado do Warehouse
|
shipments.warehouse_state | string |
O estado do armazém. |
|
Acompanhamentos
|
shipments.trackings | array of object | |
|
Número de acompanhamento
|
shipments.trackings.tracking_number | string |
O número de acompanhamento. |
|
Número de acompanhamento local
|
shipments.trackings.local_tracking_number | string |
O número de acompanhamento local. |
|
Número de acompanhamento alternativo
|
shipments.trackings.alternate_tracking_number | string |
O número de acompanhamento alternativo. |
|
Número da Perna
|
shipments.trackings.leg_number | integer |
O número da perna. |
|
Manipulador
|
shipments.trackings.handler | string |
O manipulador. |
|
Estado de acompanhamento
|
shipments.trackings.tracking_state | string |
O estado de acompanhamento. |
|
URL da Página de Acompanhamento
|
shipments.tracking_page_url | string |
O endereço da URL da página de acompanhamento. |
|
Envio de documentos
|
shipments.shipping_documents | array of |
Os documentos de envio. |
|
Moeda
|
shipments.currency | string |
A moeda. |
|
ID
|
shipments.selected_courier.id | string |
O identificador exclusivo. |
|
Taxas
|
shipments.rates | array of object | |
|
Courier ID
|
shipments.rates.courier_id | string |
O identificador exclusivo do correio. |
|
Nome do Mensageiro
|
shipments.rates.courier_name | string |
O nome do mensageiro. |
|
Tempo mínimo de entrega
|
shipments.rates.min_delivery_time | integer |
O tempo mínimo de entrega. |
|
Tempo máximo de entrega
|
shipments.rates.max_delivery_time | integer |
O tempo máximo de entrega. |
|
Valor para classificação de dinheiro
|
shipments.rates.value_for_money_rank | integer |
O valor da classificação de dinheiro. |
|
Classificação de Tempo de Entrega
|
shipments.rates.delivery_time_rank | integer |
A classificação de tempo de entrega. |
|
Encargo de remessa
|
shipments.rates.shipment_charge | float |
A carga de remessa. |
|
Sobretaxa de combustível
|
shipments.rates.fuel_surcharge | float |
A sobretaxa de combustível. |
|
Sobretaxa de área remota
|
shipments.rates.remote_area_surcharge | integer |
A sobretaxa de área remota. |
|
Sobretaxa superdimensionada
|
shipments.rates.oversized_surcharge | integer |
A sobretaxa enorme. |
|
Sobretaxa de serviços adicionais
|
shipments.rates.additional_services_surcharge | integer |
A sobretaxa de serviços adicionais. |
|
Taxa completa residencial
|
shipments.rates.residential_full_fee | integer |
A taxa total residencial. |
|
Taxa com desconto residencial
|
shipments.rates.residential_discounted_fee | integer |
A taxa de desconto residencial. |
|
Total de encargos de remessa
|
shipments.rates.shipment_charge_total | float |
O total da carga de remessa. |
|
Taxa de manipulação de armazém
|
shipments.rates.warehouse_handling_fee | integer |
A taxa de manipulação do armazém. |
|
Taxa de Seguro
|
shipments.rates.insurance_fee | integer |
A taxa do seguro. |
|
Imposto sobre vendas
|
shipments.rates.sales_tax | integer |
O imposto sobre vendas. |
|
Imposto sobre vendas provincial
|
shipments.rates.provincial_sales_tax | integer |
O imposto sobre vendas provincial. |
|
Taxa de manipulação de DDP
|
shipments.rates.ddp_handling_fee | integer |
A taxa de tratamento de DDP. |
|
Importar encargos fiscais
|
shipments.rates.import_tax_charge | integer |
A cobrança do imposto de importação. |
|
Importar encargos de direitos
|
shipments.rates.import_duty_charge | integer |
A cobrança do imposto de importação. |
|
Encargo Total
|
shipments.rates.total_charge | float |
A carga total. |
|
Está acima do limite
|
shipments.rates.is_above_threshold | boolean |
Se está acima do limite. |
|
Incoterms
|
shipments.rates.incoterms | string |
Os incoterms. |
|
Imposto de Importação Estimado
|
shipments.rates.estimated_import_tax | integer |
O imposto de importação estimado. |
|
Imposto de Importação Estimado
|
shipments.rates.estimated_import_duty | integer |
O direito de importação estimado. |
|
Opções de Entrega Disponíveis
|
shipments.rates.available_handover_options | string |
As opções de entrega disponíveis. |
|
Classificação de acompanhamento
|
shipments.rates.tracking_rating | integer |
A classificação de acompanhamento. |
|
Classificação de easyship
|
shipments.rates.easyship_rating | integer |
A classificação easyship. |
|
Comentários do Courier
|
shipments.rates.courier_remarks | string |
O correio comenta. |
|
Destinatário de Pagamento
|
shipments.rates.payment_recipient | string |
O destinatário do pagamento. |
|
Code
|
shipments.rates.discount.code | string |
O código. |
|
Quantidade
|
shipments.rates.discount.amount | integer |
O valor. |
|
Expira em
|
shipments.rates.discount.expires_at | string |
O expira em. |
|
Porcentagem
|
shipments.rates.discount.percentage | string |
A porcentagem. |
|
Incoterms eficazes
|
shipments.rates.effective_incoterms | string |
Os incoterms efetivos. |
Obter categorias de itens
Recupera uma lista de categorias de remessa e a lesma para usar a categoria.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Categorias
|
categories | array of object | |
|
Nome
|
categories.name | string |
O nome. |
|
Slug
|
categories.slug | string |
A lesma. |
Obter o status de acompanhamento
Recupera o status de acompanhamento de uma remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de remessa de easyship
|
easyship_shipment_id | True | string |
Os identificadores de remessa easyship. |
|
Número do pedido da plataforma
|
platform_order_number | string |
O número do pedido da plataforma. |
|
|
Página
|
page | integer |
A página. |
|
|
Por Página
|
per_page | integer |
O número por página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Página Total
|
total_page | integer |
A página total. |
|
Página Atual
|
current_page | integer |
A página atual. |
|
Transferências
|
shipments | array of object | |
|
ID de remessa de easyship
|
shipments.easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
Número do pedido da plataforma
|
shipments.platform_order_number | string |
O número do pedido da plataforma. |
|
Origin
|
shipments.origin | string |
A origem. |
|
Destino
|
shipments.destination | string |
O destino. |
|
Situação
|
shipments.status | string |
O status. |
|
Número de acompanhamento
|
shipments.tracking_number | string |
O número de acompanhamento. |
|
URL da Página de Acompanhamento
|
shipments.tracking_page_url | string |
O endereço da URL da página de acompanhamento. |
Obter pontos de verificação
Recupera detalhes dos pontos de verificação de remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | True | string |
O identificador exclusivo de remessa easyship. |
|
Número do pedido da plataforma
|
platform_order_number | string |
O número do pedido da plataforma. |
|
|
Página
|
page | integer |
A página. |
|
|
Por Página
|
per_page | integer |
O número por página. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Página Total
|
total_page | integer |
A página total. |
|
Página Atual
|
current_page | integer |
A página atual. |
|
Transferências
|
shipments | array of object | |
|
ID de remessa de easyship
|
shipments.easyship_shipment_id | string |
O identificador exclusivo de remessa easyship. |
|
Número do pedido da plataforma
|
shipments.platform_order_number | string |
O número do pedido da plataforma. |
|
Origin
|
shipments.origin | string |
A origem. |
|
Destino
|
shipments.destination | string |
O destino. |
|
Situação
|
shipments.status | string |
O status. |
|
Número de acompanhamento
|
shipments.tracking_number | string |
O número de acompanhamento. |
|
URL da Página de Acompanhamento
|
shipments.tracking_page_url | string |
O endereço da URL da página de acompanhamento. |
|
Pontos de Controle
|
shipments.checkpoints | array of object | |
|
Número do Pedido
|
shipments.checkpoints.order_number | integer |
O número da ordem. |
|
Manipulador
|
shipments.checkpoints.handler | string |
O manipulador. |
|
Message
|
shipments.checkpoints.message | string |
A mensagem. |
|
Localização
|
shipments.checkpoints.location | string |
O local. |
|
City
|
shipments.checkpoints.city | string |
A cidade. |
|
País
|
shipments.checkpoints.country_name | string |
O país. |
|
Código do país
|
shipments.checkpoints.country_iso3 | string |
O código do país. |
|
Coordenadas
|
shipments.checkpoints.coordinates | array of |
As coordenadas. |
|
Estado
|
shipments.checkpoints.state | string |
O estado. |
|
Código postal
|
shipments.checkpoints.postal_code | string |
O código postal. |
|
Hora do ponto de verificação
|
shipments.checkpoints.checkpoint_time | string |
A hora do ponto de verificação. |
|
Status primário
|
shipments.checkpoints.primary_status | string |
O status primário. |
Obter slots de retirada disponíveis (V1)
Os slots de retirada disponíveis serão calculados para um entregador específico, no horário local e nos próximos 7 dias. Uma retirada pode ser solicitada usando a ação "Solicitar retirada".
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Courier ID
|
courier_id | True | string |
O identificador do correio. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Courier ID
|
courier_id | string |
O identificador do correio. |
|
Nome do Mensageiro
|
courier_name | string |
O nome do mensageiro. |
|
Message
|
message | string |
A mensagem. |
|
Nome do provedor
|
pickup.provider_name | string |
O nome do provedor. |
|
Telefone do Serviço de Atendimento ao Cliente do Provedor
|
pickup.provider_customer_service_phone | string |
O número de telefone do serviço de atendimento ao cliente do provedor. |
Obter taxas e impostos
Recupere uma lista de cotações de envio para uma remessa em potencial.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Endereço
|
line_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
line_2 | string |
A linha de endereço 2. |
|
|
Estado
|
state | string |
O estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Código postal
|
postal_code | string |
O código postal. |
|
|
Código do país
|
country_alpha2 | string |
O código do país. |
|
|
Endereço
|
line_1 | string |
O endereço. |
|
|
Linha de endereço 2
|
line_2 | string |
A linha de endereço 2. |
|
|
Estado
|
state | string |
O estado. |
|
|
City
|
city | string |
A cidade. |
|
|
Código postal
|
postal_code | string |
O código postal. |
|
|
Código do país
|
country_alpha2 | string |
O código do país. |
|
|
Incoterms
|
incoterms | string |
Os incoterms. |
|
|
É Segurado
|
is_insured | boolean |
Se está segurado. |
|
|
Valor do Segurado
|
insured_amount | integer |
O valor do segurado. |
|
|
Moeda segurada
|
insured_currency | string |
A moeda segurada. |
|
|
Aplicar regras de envio
|
apply_shipping_rules | boolean |
Se as regras de envio foram aplicadas. |
|
|
Weight
|
weight | string |
O peso. |
|
|
Dimensões
|
dimensions | string |
As dimensões. |
|
|
Moeda de Saída
|
output_currency | string |
A moeda de saída. |
|
|
Peso real total
|
total_actual_weight | float |
O peso real total. |
|
|
Slug
|
slug | string |
A lesma de referência. |
|
|
Length
|
length | integer |
O comprimento. |
|
|
Largura
|
width | integer |
A largura. |
|
|
Altura
|
height | integer |
A altura. |
|
|
Description
|
description | string |
A descrição. |
|
|
Categoria
|
category | string |
A categoria. |
|
|
SKU
|
sku | string |
A SKU. |
|
|
Quantidade
|
quantity | integer |
A quantidade. |
|
|
Length
|
length | string |
O comprimento. |
|
|
Largura
|
width | string |
A largura. |
|
|
Altura
|
height | string |
A altura. |
|
|
Peso real
|
actual_weight | integer |
O peso real. |
|
|
Moeda Declarada
|
declared_currency | string |
A moeda declarada. |
|
|
Valor alfandegário declarado
|
declared_customs_value | integer |
O valor alfandegário declarado. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Taxas
|
rates | array of object | |
|
Courier ID
|
rates.courier_id | string |
O identificador exclusivo do correio. |
|
Nome do Mensageiro
|
rates.courier_name | string |
O nome do mensageiro. |
|
Tempo mínimo de entrega
|
rates.min_delivery_time | integer |
O tempo mínimo de entrega. |
|
Tempo máximo de entrega
|
rates.max_delivery_time | integer |
O tempo máximo de entrega. |
|
Valor para classificação de dinheiro
|
rates.value_for_money_rank | integer |
O valor da classificação de dinheiro. |
|
Classificação de Tempo de Entrega
|
rates.delivery_time_rank | integer |
A classificação de tempo de entrega. |
|
Encargo de remessa
|
rates.shipment_charge | float |
A carga de remessa. |
|
Sobretaxa de combustível
|
rates.fuel_surcharge | float |
A sobretaxa de combustível. |
|
Sobretaxa de área remota
|
rates.remote_area_surcharge | integer |
A sobretaxa de área remota. |
|
Total de encargos de remessa
|
rates.shipment_charge_total | float |
O total da carga de remessa. |
|
Taxa de manipulação de armazém
|
rates.warehouse_handling_fee | integer |
A taxa de manipulação do armazém. |
|
Taxa de Seguro
|
rates.insurance_fee | integer |
A taxa do seguro. |
|
Taxa de manipulação de DDP
|
rates.ddp_handling_fee | integer |
A taxa de tratamento de DDP se o incoterm for DDP. |
|
Importar encargos fiscais
|
rates.import_tax_charge | integer |
A cobrança do imposto de importação. |
|
Importar encargos de direitos
|
rates.import_duty_charge | integer |
A cobrança do imposto de importação. |
|
Encargo Total
|
rates.total_charge | float |
A carga total. |
|
Está acima do limite
|
rates.is_above_threshold | boolean |
Se está acima do limite. |
|
Incoterms eficazes
|
rates.effective_incoterms | string |
Os incoterms efetivos. |
|
Imposto de Importação Estimado
|
rates.estimated_import_tax | integer |
O imposto de importação estimado. |
|
Imposto de Importação Estimado
|
rates.estimated_import_duty | integer |
O direito de importação estimado. |
|
Courier faz a retirada
|
rates.courier_does_pickup | boolean |
Se o mensageiro faz a retirada. |
|
Courier Dropoff URL
|
rates.courier_dropoff_url | string |
O endereço da URL do entregador. |
|
Classificação de acompanhamento
|
rates.tracking_rating | integer |
A classificação de acompanhamento. |
|
Destinatário de Pagamento
|
rates.payment_recipient | string |
O destinatário do pagamento. |
|
Comentários do Courier
|
rates.courier_remarks | string |
O correio comenta. |
|
Moeda
|
rates.currency | string |
A moeda. |
|
Nome
|
rates.box.name | string |
O nome. |
|
Length
|
rates.box.length | integer |
O comprimento. |
|
Largura
|
rates.box.width | integer |
A largura. |
|
Altura
|
rates.box.height | integer |
A altura. |
|
Taxa mínima de retirada
|
rates.minimum_pickup_fee | integer |
A taxa mínima de retirada. |
|
Description
|
rates.title | string |
A descrição. |
|
Descrição completa
|
rates.full_description | string |
A descrição completa. |
Obter uma remessa
Obtenha os detalhes de uma remessa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID de remessa de easyship
|
easyship_shipment_id | True | string |
O identificador de remessa easyship. |
|
Formato
|
format | string |
O formato. |
|
|
Etiqueta
|
label | string |
O rótulo. |
|
|
Fatura Comercial
|
commercial_invoice | string |
A fatura comercial. |
|
|
Deslizamento de embalagem
|
packing_slip | string |
O deslizamento de embalagem. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Criado em
|
created_at | string |
Quando criado em. |
|
Atualizado em
|
updated_at | string |
Quando atualizar em. |
|
ID de remessa de easyship
|
easyship_shipment_id | string |
O indentifier de remessa easyship. |
|
Nome do destino
|
destination_name | string |
O nome do destino. |
|
Endereço de destino
|
destination_address_line_1 | string |
O endereço de destino. |
|
Linha de Endereço de Destino 2
|
destination_address_line_2 | string |
A linha de endereço de destino 2. |
|
Cidade de Destino
|
destination_city | string |
A cidade de destino. |
|
Estado de destino
|
destination_state | string |
O estado de destino. |
|
Cep de destino
|
destination_postal_code | string |
O código postal de destino. |
|
Número de telefone de destino
|
destination_phone_number | string |
O número de telefone de destino. |
|
Endereço de email de destino
|
destination_email_address | string |
O endereço de email de destino. |
|
Anotações do pedido
|
order_notes | string |
As anotações do pedido. |
|
Pedido criado em
|
order_created_at | string |
A ordem criada em. |
|
Nome da plataforma
|
platform_name | string |
O nome da plataforma. |
|
Número do pedido da plataforma
|
platform_order_number | string |
O número do pedido da plataforma. |
|
Valor total da alfândega
|
total_customs_value | float |
O valor total da alfândega. |
|
Peso real total
|
total_actual_weight | float |
O peso real total. |
|
Peso Dimensional Total
|
total_dimensional_weight | float |
O peso dimensional total. |
|
Peso Volumetrico Total
|
total_volumetric_weight | float |
O peso volumetrico total. |
|
É Segurado
|
is_insured | boolean |
Se está segurado. |
|
Moeda
|
currency | string |
A moeda. |
|
Estado do Warehouse
|
warehouse_state | string |
O estado do armazém. |
|
Nome
|
origin_country.name | string |
O nome. |
|
Código do país
|
origin_country.alpha2 | string |
O código do país. |
|
Nome
|
destination_country.name | string |
O nome. |
|
Código do país
|
destination_country.alpha2 | string |
O código do país. |
|
Itens
|
items | array of object | |
|
ID
|
items.id | string |
O identificador exclusivo. |
|
Description
|
items.title | string |
A descrição. |
|
SKU
|
items.sku | string |
A SKU. |
|
Largura
|
items.width | integer |
A largura. |
|
Length
|
items.length | integer |
O comprimento. |
|
Altura
|
items.height | integer |
A altura. |
|
Peso real
|
items.actual_weight | float |
O peso real. |
|
Peso Dimensional
|
items.dimensional_weight | float |
O peso dimensional. |
|
Peso volumétrica
|
items.volumetric_weight | float |
O peso volumetrico. |
|
Valor alfandegário declarado
|
items.declared_customs_value | integer |
O valor alfandegário declarado. |
|
Moeda Declarada
|
items.declared_currency | string |
A moeda declarada. |
|
Valor alfandegário de origem
|
items.origin_customs_value | float |
O valor alfandegário de origem. |
|
Moeda de origem
|
items.origin_currency | string |
A moeda de origem. |
|
Categoria
|
items.category | string |
A categoria. |
|
Nome
|
box.name | string |
O nome. |
|
Length
|
box.length | integer |
O comprimento. |
|
Largura
|
box.width | integer |
A largura. |
|
Altura
|
box.height | integer |
A altura. |
|
ID
|
selected_courier.id | string |
O identificador exclusivo. |
|
Nome
|
selected_courier.name | string |
O nome. |
|
Tempo mínimo de entrega
|
selected_courier.min_delivery_time | integer |
O tempo mínimo de entrega. |
|
Tempo máximo de entrega
|
selected_courier.max_delivery_time | integer |
O tempo máximo de entrega. |
|
Encargo de remessa
|
selected_courier.shipment_charge | float |
A carga de remessa. |
|
Sobretaxa de combustível
|
selected_courier.fuel_surcharge | float |
A sobretaxa de combustível. |
|
Sobretaxa de área remota
|
selected_courier.remote_area_surcharge | integer |
A sobretaxa de área remota. |
|
Total de encargos de remessa
|
selected_courier.shipment_charge_total | float |
O total da carga de remessa. |
|
Taxa de manipulação de armazém
|
selected_courier.warehouse_handling_fee | integer |
A taxa de manipulação do armazém. |
|
Taxa de Seguro
|
selected_courier.insurance_fee | integer |
A taxa do seguro. |
|
Importar encargos fiscais
|
selected_courier.import_tax_charge | integer |
A cobrança do imposto de importação. |
|
Importar encargos de direitos
|
selected_courier.import_duty_charge | integer |
A cobrança do imposto de importação. |
|
Taxa de manipulação de DDP
|
selected_courier.ddp_handling_fee | integer |
A taxa de tratamento de DDP. |
|
Encargo Total
|
selected_courier.total_charge | float |
A carga total. |
|
Está acima do limite
|
selected_courier.is_above_threshold | boolean |
Se está acima do limite. |
|
Incoterms eficazes
|
selected_courier.effective_incoterms | string |
Os incoterms efetivos. |
|
Imposto de Importação Estimado
|
selected_courier.estimated_import_tax | integer |
O imposto importado estimado. |
|
Imposto de Importação Estimado
|
selected_courier.estimated_import_duty | integer |
O direito de importação estimado. |
|
Courier faz a retirada
|
selected_courier.courier_does_pickup | boolean |
Se o mensageiro faz a retirada. |
|
Courier Dropoff URL
|
selected_courier.courier_dropoff_url | string |
O endereço da URL do entregador. |
|
Comentários do Courier
|
selected_courier.courier_remarks | string |
O correio comenta. |
|
Destinatário de Pagamento
|
selected_courier.payment_recipient | string |
O destinatário do pagamento. |
|
Obrigatório
|
shipping_documents.label.required | boolean |
Se necessário. |
|
Tamanho da Página
|
shipping_documents.label.page_size | string |
O tamanho da página. |
|
Formato
|
shipping_documents.label.format | string |
O formato. |
|
Cadeias de caracteres codificadas em Base64
|
shipping_documents.label.base64_encoded_strings | array of string |
As cadeias de caracteres codificadas em Base64. |
|
URL
|
shipping_documents.label.url | string |
O endereço da URL. |
|
Message
|
shipping_documents.label.message | string |
A mensagem. |
|
Obrigatório
|
shipping_documents.commercial_invoice.required | boolean |
Se necessário. |
|
Tamanho da Página
|
shipping_documents.commercial_invoice.page_size | string |
O tamanho da página. |
|
Formato
|
shipping_documents.commercial_invoice.format | string |
O formato. |
|
Cadeias de caracteres codificadas em Base64
|
shipping_documents.commercial_invoice.base64_encoded_strings | array of |
As cadeias de caracteres codificadas em Base64. |
|
URL
|
shipping_documents.commercial_invoice.url | string |
O endereço da URL. |
|
Obrigatório
|
shipping_documents.packing_slip.required | boolean |
Se necessário. |
|
Tamanho da Página
|
shipping_documents.packing_slip.page_size | string |
O tamanho da página. |
|
Formato
|
shipping_documents.packing_slip.format | string |
O formato. |
|
Cadeias de caracteres codificadas em Base64
|
shipping_documents.packing_slip.base64_encoded_strings | array of string |
As cadeias de caracteres codificadas em Base64. |
|
URL
|
shipping_documents.packing_slip.url | string |
O endereço da URL. |
|
Obrigatório
|
shipping_documents.battery_form.required | boolean |
Se necessário. |
|
Tamanho da Página
|
shipping_documents.battery_form.page_size | string |
O tamanho da página. |
|
Formato
|
shipping_documents.battery_form.format | string |
O formato. |
|
Cadeias de caracteres codificadas em Base64
|
shipping_documents.battery_form.base64_encoded_strings | array of |
As cadeias de caracteres codificadas em Base64. |
|
URL
|
shipping_documents.battery_form.url | string |
O endereço da URL. |
|
Obrigatório
|
shipping_documents.battery_caution_label.required | boolean |
Se necessário. |
|
Tamanho da Página
|
shipping_documents.battery_caution_label.page_size | string |
O tamanho da página. |
|
Formato
|
shipping_documents.battery_caution_label.format | string |
O formato. |
|
Cadeias de caracteres codificadas em Base64
|
shipping_documents.battery_caution_label.base64_encoded_strings | array of |
As cadeias de caracteres codificadas em Base64. |
|
URL
|
shipping_documents.battery_caution_label.url | string |
O endereço da URL. |
Solicitar uma retirada (V1)
Quando uma retirada é criada, uma solicitação de retirada será feita diretamente para o entregador, que retornará um número de referência. O número de referência pode ser usado ao entrar em contato com o atendimento ao cliente do entregador. Um slot de retirada deve ser escolhido; os slots de retirada futuros podem ser encontrados usando a ação "Obter slots de retirada disponíveis".
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Courier ID
|
courier_id | string |
O identificador do correio. |
|
|
Data preferencial
|
preferred_date | string |
A data preferencial. |
|
|
Tempo Máximo Preferencial
|
preferred_max_time | string |
O tempo máximo preferencial. |
|
|
Tempo Mínimo Preferencial
|
preferred_min_time | string |
O tempo mínimo preferencial. |
|
|
IDs de remessa de easyship
|
easyship_shipment_ids | array of string |
Os identifers de remessa easyship. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Courier ID
|
courier_id | string |
O identificador do correio. |
|
Nome do Mensageiro
|
courier_name | string |
O nome do mensageiro. |
|
IDs de remessa de easyship
|
easyship_shipment_ids | array of string |
Os identificadores de remessa easyship. |
|
Easyship Pickup ID
|
pickup.easyship_pickup_id | string |
O identificador de retirada do Easyship. |
|
Tempo Mínimo Preferencial
|
pickup.preferred_min_time | string |
O tempo mínimo preferencial. |
|
Tempo Máximo Preferencial
|
pickup.preferred_max_time | string |
O tempo máximo preferencial. |
|
Número de referência de retirada
|
pickup.pickup_reference_number | string |
O número de referência de retirada. |
|
Taxa de Retirada
|
pickup.pickup_fee | string |
A taxa de retirada. |
|
Nome do provedor
|
pickup.provider_name | string |
O nome do provedor. |
|
Telefone do Serviço de Atendimento ao Cliente do Provedor
|
pickup.provider_customer_service_phone | string |
O número de telefone do serviço de atendimento ao cliente do provedor. |
|
Contagem de remessas
|
pickup.shipments_count | string |
A contagem de remessas. |
|
Peso real total
|
pickup.total_actual_weight | string |
O peso real total. |
|
Estado de retirada
|
pickup.pickup_state | string |
O estado de retirada. |
|
Endereço
|
pickup.address.line_1 | string |
O endereço. |
|
Linha de endereço 2
|
pickup.address.line_2 | string |
A linha de endereço 2. |
|
Linha de Endereço 3
|
pickup.address.line_3 | string |
A linha de endereço 3. |
|
Código postal
|
pickup.address.postal_code | string |
O código postal. |
|
City
|
pickup.address.city | string |
A cidade. |
|
Estado
|
pickup.address.state | string |
O estado. |
|
País
|
pickup.address.country | string |
O país. |
|
Email de contato
|
pickup.address.contact_email | string |
O endereço de email de contato. |
|
Telefone de contato
|
pickup.address.contact_phone | string |
O número de telefone do contato. |
|
Nome da Empresa
|
pickup.address.company_name | string |
O nome da empresa. |
|
Nome do contato
|
pickup.address.contact_name | string |
O nome do contato. |