AfterShip (Editora Independente) (Pré-visualização)
AfterShip é uma solução de rastreamento de embarque. Tem parcerias com mais de 900 operadoras em todo o mundo, incluindo serviços populares como FedEx, DHL, etc. Esse conector permite que um usuário rastreie e receba notificações sobre remessas e se integre a outros serviços, como o Dynamics 365 e serviços de terceiros, para fortalecer seu comércio eletrônico ou simplificar seus processos de negócios internos.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Taiki Yoshida |
| URL | https://memo.tyoshida.me/power-platform/connectors/aftership-connector/ |
| tayoshi@microsoft.com |
| Metadados do conector | |
|---|---|
| Editora | Taiki Yoshida |
| Sítio Web | https://www.aftership.com |
| Política de privacidade | https://www.automizely.com/legal/privacy |
| Categorias | Commerce |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | securestring | A chave da API do aplicativo/assinatura emitida pelo AfterShip | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar uma notificação |
Adicione destinatários de notificação a um número de rastreamento. |
| Atualizar um acompanhamento |
Atualize um rastreamento. |
| Criar rastreamento |
Crie um acompanhamento. |
| Detetar correio |
Devolva uma lista de entregadores correspondentes com base no formato do número de rastreamento e transportadoras selecionadas ou uma lista de entregadores. |
| Excluir um rastreamento |
Exclua um rastreamento. |
| Marcar o acompanhamento como concluído |
Marque um acompanhamento como concluído. O rastreamento não será atualizado automaticamente até que seja rastreado novamente. |
| Obter notificação de rastreamento |
Obtenha informações de contato para que os usuários notifiquem quando o rastreamento for alterado. Por favor, note que apenas os destinatários dos clientes serão devolvidos. Qualquer |
| Obter o último ponto de verificação |
Retorne as informações de rastreamento do último ponto de verificação de um único rastreamento. |
| Obter rastreamentos |
Obtenha resultados de acompanhamento de vários rastreamentos. |
| Obter transportadoras ativadas pelo usuário |
Devolva uma lista de estafetas ativados na sua conta AfterShip. |
| Obter um rastreamento |
Obtenha resultados de acompanhamento de um único rastreamento. |
| Rastrear novamente um rastreamento expirado |
Rastreie novamente um rastreamento expirado. Máximo de 3 vezes por rastreamento. |
| Receba todos os estafetas |
Devolva uma lista de todos os estafetas. |
| Remover uma notificação |
Remova os recetores de notificação de um número de rastreamento. |
Adicionar uma notificação
Adicione destinatários de notificação a um número de rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
E-mails
|
data.notification.emails | array of |
Endereços de e-mail |
|
SMEs
|
data.notification.smses | array of string |
SMS |
Atualizar um acompanhamento
Atualize um rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
|
title
|
title | string |
title |
|
|
Observação
|
note | string |
Observações |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
id
|
data.tracking.id | string |
ID |
|
criado_em
|
data.tracking.created_at | string |
Data e hora de criação |
|
updated_at
|
data.tracking.updated_at | string |
Data e hora atualizadas |
|
last_updated_at
|
data.tracking.last_updated_at | string |
Data e hora da última atualização |
|
tracking_number
|
data.tracking.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.tracking.slug | string |
Nome do Correio |
|
active
|
data.tracking.active | boolean |
Rastreamento ativo ou inativo |
|
androide
|
data.tracking.android | array of |
Android |
|
custom_fields
|
data.tracking.custom_fields | string |
Campos personalizados |
|
customer_name
|
data.tracking.customer_name | string |
Nome do Cliente |
|
delivery_time
|
data.tracking.delivery_time | integer |
Data e hora de entrega |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Código do país de destino em formato ISO 3 |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Código do país do correio expresso em formato ISO 3 |
|
E-mails
|
data.tracking.emails | array of |
Endereços de e-mail |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Data e hora de entrega previstas |
|
iOS
|
data.tracking.ios | array of |
iOS |
|
Observação
|
data.tracking.note | string |
Observações |
|
order_id
|
data.tracking.order_id | string |
ID da encomenda |
|
order_id_path
|
data.tracking.order_id_path | string |
Caminho do ID do pedido |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Código do país de origem no formato ISO 3 |
|
shipment_package_count
|
data.tracking.shipment_package_count | integer |
Número de pacotes na remessa |
|
shipment_pickup_date
|
data.tracking.shipment_pickup_date | string |
Data e hora de levantamento das encomendas |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Data e hora das encomendas entregues |
|
shipment_type
|
data.tracking.shipment_type | string |
Tipo de envio |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Peso da remessa |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unidade de peso da remessa |
|
signed_by
|
data.tracking.signed_by | string |
Assinado por |
|
SMEs
|
data.tracking.smses | array of |
SMS |
|
origem
|
data.tracking.source | string |
Fonte |
|
etiqueta
|
data.tracking.tag | string |
Etiquetas |
|
subtag
|
data.tracking.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.subtag_message | string |
Mensagens de subtag |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Número de vezes rastreadas |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | string |
O rastreamento da última milha é suportado |
|
linguagem
|
data.tracking.language | string |
Linguagem |
|
unique_token
|
data.tracking.unique_token | string |
Token único |
|
pontos de controlo
|
data.tracking.checkpoints | array of object |
pontos de controlo |
|
lesma
|
data.tracking.checkpoints.slug | string |
Nome do Correio |
|
city
|
data.tracking.checkpoints.city | string |
City |
|
criado_em
|
data.tracking.checkpoints.created_at | string |
Data e hora de criação |
|
localização
|
data.tracking.checkpoints.location | string |
Localização |
|
country_name
|
data.tracking.checkpoints.country_name | string |
Nome do país |
|
mensagem
|
data.tracking.checkpoints.message | string |
Message |
|
country_iso3
|
data.tracking.checkpoints.country_iso3 | string |
Código do país em formato ISO 3 |
|
etiqueta
|
data.tracking.checkpoints.tag | string |
Etiquetas |
|
subtag
|
data.tracking.checkpoints.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.checkpoints.subtag_message | string |
Mensagens de subtag |
|
checkpoint_time
|
data.tracking.checkpoints.checkpoint_time | string |
Ponto de verificação do tempo alcançado |
|
coordenadas
|
data.tracking.checkpoints.coordinates | array of |
Coordenadas |
|
state
|
data.tracking.checkpoints.state | string |
Estado |
|
ZIP
|
data.tracking.checkpoints.zip | string |
Código postal |
|
raw_tag
|
data.tracking.checkpoints.raw_tag | string |
Tags brutas |
|
subscribed_smses
|
data.tracking.subscribed_smses | array of |
subscribed_smses |
|
subscribed_emails
|
data.tracking.subscribed_emails | array of |
subscribed_emails |
|
return_to_sender
|
data.tracking.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.tracking.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.tracking.delivery_type | string |
delivery_type |
|
pickup_location
|
data.tracking.pickup_location | string |
pickup_location |
|
pickup_note
|
data.tracking.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.tracking.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.tracking.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.tracking.first_attempted_at | string |
first_attempted_at |
Criar rastreamento
Crie um acompanhamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
lesma
|
slug | string |
Nome do Correio |
|
|
tracking_number
|
tracking_number | string |
Número de rastreamento |
|
|
title
|
title | string |
title |
|
|
SMEs
|
smses | array of |
SMS |
|
|
E-mails
|
emails | array of |
Endereços de e-mail |
|
|
order_id
|
order_id | string |
ID da encomenda |
|
|
order_id_path
|
order_id_path | string |
Caminho do ID do pedido |
|
|
product_name
|
product_name | string |
product_name |
|
|
product_price
|
product_price | string |
product_price |
|
|
linguagem
|
language | string |
Linguagem |
|
|
order_promised_delivery_date
|
order_promised_delivery_date | string |
order_promised_delivery_date |
|
|
delivery_type
|
delivery_type | string |
delivery_type |
|
|
pickup_location
|
pickup_location | string |
pickup_location |
|
|
pickup_note
|
pickup_note | string |
pickup_note |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
id
|
data.tracking.id | string |
ID |
|
criado_em
|
data.tracking.created_at | string |
Data e hora de criação |
|
updated_at
|
data.tracking.updated_at | string |
Data e hora atualizadas |
|
last_updated_at
|
data.tracking.last_updated_at | string |
Data e hora da última atualização |
|
tracking_number
|
data.tracking.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.tracking.slug | string |
Nome do Correio |
|
active
|
data.tracking.active | boolean |
Rastreamento ativo ou inativo |
|
androide
|
data.tracking.android | array of |
Android |
|
custom_fields
|
data.tracking.custom_fields | string |
Campos personalizados |
|
customer_name
|
data.tracking.customer_name | string |
Nome do Cliente |
|
delivery_time
|
data.tracking.delivery_time | integer |
Data e hora de entrega |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Código do país de destino em formato ISO 3 |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Código do país do correio expresso em formato ISO 3 |
|
E-mails
|
data.tracking.emails | array of |
Endereços de e-mail |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Data e hora de entrega previstas |
|
iOS
|
data.tracking.ios | array of |
iOS |
|
Observação
|
data.tracking.note | string |
Observações |
|
order_id
|
data.tracking.order_id | string |
ID da encomenda |
|
order_id_path
|
data.tracking.order_id_path | string |
Caminho do ID do pedido |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Código do país de origem no formato ISO 3 |
|
shipment_package_count
|
data.tracking.shipment_package_count | integer |
Número de pacotes na remessa |
|
shipment_pickup_date
|
data.tracking.shipment_pickup_date | string |
Data e hora de levantamento das encomendas |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Data e hora das encomendas entregues |
|
shipment_type
|
data.tracking.shipment_type | string |
Tipo de envio |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Peso da remessa |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unidade de peso da remessa |
|
signed_by
|
data.tracking.signed_by | string |
Assinado por |
|
SMEs
|
data.tracking.smses | array of |
SMS |
|
origem
|
data.tracking.source | string |
Fonte |
|
etiqueta
|
data.tracking.tag | string |
Etiquetas |
|
subtag
|
data.tracking.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.subtag_message | string |
Mensagens de subtag |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Número de vezes rastreadas |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | boolean |
O rastreamento da última milha é suportado |
|
linguagem
|
data.tracking.language | string |
Linguagem |
|
unique_token
|
data.tracking.unique_token | string |
Token único |
|
pontos de controlo
|
data.tracking.checkpoints | array of |
pontos de controlo |
|
subscribed_smses
|
data.tracking.subscribed_smses | array of |
subscribed_smses |
|
subscribed_emails
|
data.tracking.subscribed_emails | array of |
subscribed_emails |
|
return_to_sender
|
data.tracking.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.tracking.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.tracking.delivery_type | string |
delivery_type |
|
pickup_location
|
data.tracking.pickup_location | string |
pickup_location |
|
pickup_note
|
data.tracking.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.tracking.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.tracking.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.tracking.first_attempted_at | string |
first_attempted_at |
Detetar correio
Devolva uma lista de entregadores correspondentes com base no formato do número de rastreamento e transportadoras selecionadas ou uma lista de entregadores.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
tracking_number
|
tracking_number | string |
Número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
total
|
data.total | integer |
total |
|
estafetas
|
data.couriers | array of object |
Informação dos estafetas |
|
lesma
|
data.couriers.slug | string |
Nome do Correio |
|
nome
|
data.couriers.name | string |
Nome |
|
phone
|
data.couriers.phone | string |
Número de telefone |
|
other_name
|
data.couriers.other_name | string |
Nome alternativo |
|
web_url
|
data.couriers.web_url | string |
URL do site |
|
required_fields
|
data.couriers.required_fields | array of string |
Campos obrigatórios |
|
optional_fields
|
data.couriers.optional_fields | array of string |
Campos opcionais |
|
default_language
|
data.couriers.default_language | string |
Idioma padrão |
|
support_languages
|
data.couriers.support_languages | array of string |
Idiomas suportados |
|
service_from_country_iso3
|
data.couriers.service_from_country_iso3 | array of string |
Código do país do serviço em formato ISO3 |
Excluir um rastreamento
Exclua um rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
id
|
data.tracking.id | string |
ID |
|
tracking_number
|
data.tracking.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.tracking.slug | string |
Nome do Correio |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
Marcar o acompanhamento como concluído
Marque um acompanhamento como concluído. O rastreamento não será atualizado automaticamente até que seja rastreado novamente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
|
razão
|
reason | string |
razão |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
mensagem
|
meta.message | string |
Message |
|
tipo
|
meta.type | string |
tipo |
Obter notificação de rastreamento
Obtenha informações de contato para que os usuários notifiquem quando o rastreamento for alterado. Por favor, note que apenas os destinatários dos clientes serão devolvidos. Qualquer email, sms ou webhook que pertença à Loja não será devolvido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
E-mails
|
data.notification.emails | array of |
Endereços de e-mail |
|
SMEs
|
data.notification.smses | array of string |
SMS |
Obter o último ponto de verificação
Retorne as informações de rastreamento do último ponto de verificação de um único rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
id
|
data.id | string |
ID |
|
tracking_number
|
data.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.slug | string |
Nome do Correio |
|
etiqueta
|
data.tag | string |
Etiquetas |
|
subtag
|
data.subtag | string |
Sub tags |
|
subtag_message
|
data.subtag_message | string |
Mensagens de subtag |
|
lesma
|
data.checkpoint.slug | string |
Nome do Correio |
|
criado_em
|
data.checkpoint.created_at | string |
Data e hora de criação |
|
checkpoint_time
|
data.checkpoint.checkpoint_time | string |
Ponto de verificação do tempo alcançado |
|
city
|
data.checkpoint.city | string |
City |
|
coordenadas
|
data.checkpoint.coordinates | array of |
Coordenadas |
|
country_iso3
|
data.checkpoint.country_iso3 | string |
Código do país em formato ISO 3 |
|
country_name
|
data.checkpoint.country_name | string |
Nome do país |
|
mensagem
|
data.checkpoint.message | string |
Message |
|
state
|
data.checkpoint.state | string |
Estado |
|
etiqueta
|
data.checkpoint.tag | string |
Etiquetas |
|
subtag
|
data.checkpoint.subtag | string |
Sub tags |
|
subtag_message
|
data.checkpoint.subtag_message | string |
Mensagens de subtag |
|
ZIP
|
data.checkpoint.zip | string |
Código postal |
|
raw_tag
|
data.checkpoint.raw_tag | string |
Tags brutas |
Obter rastreamentos
Obtenha resultados de acompanhamento de vários rastreamentos.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
página
|
data.page | integer |
página |
|
limit
|
data.limit | integer |
limit |
|
count
|
data.count | integer |
count |
|
palavra-chave
|
data.keyword | string |
palavra-chave |
|
lesma
|
data.slug | string |
Nome do Correio |
|
origin
|
data.origin | array of |
origin |
|
destino
|
data.destination | array of |
destino |
|
etiqueta
|
data.tag | string |
Etiquetas |
|
campos
|
data.fields | string |
campos |
|
created_at_min
|
data.created_at_min | string |
created_at_min |
|
created_at_max
|
data.created_at_max | string |
created_at_max |
|
last_updated_at
|
data.last_updated_at | string |
Data e hora da última atualização |
|
return_to_sender
|
data.return_to_sender | array of |
return_to_sender |
|
courier_destination_country_iso3
|
data.courier_destination_country_iso3 | array of |
Código do país do correio expresso em formato ISO 3 |
|
rastreamentos
|
data.trackings | array of object |
rastreamentos |
|
id
|
data.trackings.id | string |
ID |
|
criado_em
|
data.trackings.created_at | string |
Data e hora de criação |
|
updated_at
|
data.trackings.updated_at | string |
Data e hora atualizadas |
|
last_updated_at
|
data.trackings.last_updated_at | string |
Data e hora da última atualização |
|
tracking_number
|
data.trackings.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.trackings.slug | string |
Nome do Correio |
|
active
|
data.trackings.active | boolean |
Rastreamento ativo ou inativo |
|
androide
|
data.trackings.android | array of |
Android |
|
custom_fields
|
data.trackings.custom_fields | string |
Campos personalizados |
|
customer_name
|
data.trackings.customer_name | string |
Nome do Cliente |
|
delivery_time
|
data.trackings.delivery_time | integer |
Data e hora de entrega |
|
destination_country_iso3
|
data.trackings.destination_country_iso3 | string |
Código do país de destino em formato ISO 3 |
|
courier_destination_country_iso3
|
data.trackings.courier_destination_country_iso3 | string |
Código do país do correio expresso em formato ISO 3 |
|
E-mails
|
data.trackings.emails | array of string |
Endereços de e-mail |
|
expected_delivery
|
data.trackings.expected_delivery | string |
Data e hora de entrega previstas |
|
iOS
|
data.trackings.ios | array of |
iOS |
|
Observação
|
data.trackings.note | string |
Observações |
|
order_id
|
data.trackings.order_id | string |
ID da encomenda |
|
order_id_path
|
data.trackings.order_id_path | string |
Caminho do ID do pedido |
|
origin_country_iso3
|
data.trackings.origin_country_iso3 | string |
Código do país de origem no formato ISO 3 |
|
shipment_package_count
|
data.trackings.shipment_package_count | integer |
Número de pacotes na remessa |
|
shipment_pickup_date
|
data.trackings.shipment_pickup_date | string |
Data e hora de levantamento das encomendas |
|
shipment_delivery_date
|
data.trackings.shipment_delivery_date | string |
Data e hora das encomendas entregues |
|
shipment_type
|
data.trackings.shipment_type | string |
Tipo de envio |
|
shipment_weight
|
data.trackings.shipment_weight | string |
Peso da remessa |
|
shipment_weight_unit
|
data.trackings.shipment_weight_unit | string |
Unidade de peso da remessa |
|
signed_by
|
data.trackings.signed_by | string |
Assinado por |
|
SMEs
|
data.trackings.smses | array of string |
SMS |
|
origem
|
data.trackings.source | string |
Fonte |
|
etiqueta
|
data.trackings.tag | string |
Etiquetas |
|
subtag
|
data.trackings.subtag | string |
Sub tags |
|
subtag_message
|
data.trackings.subtag_message | string |
Mensagens de subtag |
|
title
|
data.trackings.title | string |
title |
|
tracked_count
|
data.trackings.tracked_count | integer |
Número de vezes rastreadas |
|
last_mile_tracking_supported
|
data.trackings.last_mile_tracking_supported | string |
O rastreamento da última milha é suportado |
|
linguagem
|
data.trackings.language | string |
Linguagem |
|
unique_token
|
data.trackings.unique_token | string |
Token único |
|
pontos de controlo
|
data.trackings.checkpoints | array of object |
pontos de controlo |
|
lesma
|
data.trackings.checkpoints.slug | string |
Nome do Correio |
|
city
|
data.trackings.checkpoints.city | string |
City |
|
criado_em
|
data.trackings.checkpoints.created_at | string |
Data e hora de criação |
|
localização
|
data.trackings.checkpoints.location | string |
Localização |
|
country_name
|
data.trackings.checkpoints.country_name | string |
Nome do país |
|
mensagem
|
data.trackings.checkpoints.message | string |
Message |
|
country_iso3
|
data.trackings.checkpoints.country_iso3 | string |
Código do país em formato ISO 3 |
|
etiqueta
|
data.trackings.checkpoints.tag | string |
Etiquetas |
|
subtag
|
data.trackings.checkpoints.subtag | string |
Sub tags |
|
subtag_message
|
data.trackings.checkpoints.subtag_message | string |
Mensagens de subtag |
|
checkpoint_time
|
data.trackings.checkpoints.checkpoint_time | string |
Ponto de verificação do tempo alcançado |
|
coordenadas
|
data.trackings.checkpoints.coordinates | array of |
Coordenadas |
|
state
|
data.trackings.checkpoints.state | string |
Estado |
|
ZIP
|
data.trackings.checkpoints.zip | string |
Código postal |
|
raw_tag
|
data.trackings.checkpoints.raw_tag | string |
Tags brutas |
|
subscribed_smses
|
data.trackings.subscribed_smses | array of string |
subscribed_smses |
|
subscribed_emails
|
data.trackings.subscribed_emails | array of string |
subscribed_emails |
|
return_to_sender
|
data.trackings.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.trackings.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.trackings.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.trackings.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.trackings.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.trackings.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.trackings.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.trackings.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.trackings.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.trackings.delivery_type | string |
delivery_type |
|
pickup_location
|
data.trackings.pickup_location | string |
pickup_location |
|
pickup_note
|
data.trackings.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.trackings.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.trackings.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.trackings.first_attempted_at | string |
first_attempted_at |
Obter transportadoras ativadas pelo usuário
Devolva uma lista de estafetas ativados na sua conta AfterShip.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
total
|
data.total | integer |
total |
|
estafetas
|
data.couriers | array of object |
Informação dos estafetas |
|
lesma
|
data.couriers.slug | string |
Nome do Correio |
|
nome
|
data.couriers.name | string |
Nome |
|
phone
|
data.couriers.phone | string |
Número de telefone |
|
other_name
|
data.couriers.other_name | string |
Nome alternativo |
|
web_url
|
data.couriers.web_url | string |
URL do site |
|
required_fields
|
data.couriers.required_fields | array of string |
Campos obrigatórios |
|
optional_fields
|
data.couriers.optional_fields | array of string |
Campos opcionais |
|
default_language
|
data.couriers.default_language | string |
Idioma padrão |
|
support_languages
|
data.couriers.support_languages | array of string |
Idiomas suportados |
|
service_from_country_iso3
|
data.couriers.service_from_country_iso3 | array of string |
Código do país do serviço em formato ISO3 |
Obter um rastreamento
Obtenha resultados de acompanhamento de um único rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
id
|
data.tracking.id | string |
ID |
|
criado_em
|
data.tracking.created_at | string |
Data e hora de criação |
|
updated_at
|
data.tracking.updated_at | string |
Data e hora atualizadas |
|
last_updated_at
|
data.tracking.last_updated_at | string |
Data e hora da última atualização |
|
tracking_number
|
data.tracking.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.tracking.slug | string |
Nome do Correio |
|
active
|
data.tracking.active | boolean |
Rastreamento ativo ou inativo |
|
androide
|
data.tracking.android | array of |
Android |
|
custom_fields
|
data.tracking.custom_fields | string |
Campos personalizados |
|
customer_name
|
data.tracking.customer_name | string |
Nome do Cliente |
|
delivery_time
|
data.tracking.delivery_time | integer |
Data e hora de entrega |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Código do país de destino em formato ISO 3 |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Código do país do correio expresso em formato ISO 3 |
|
E-mails
|
data.tracking.emails | array of |
Endereços de e-mail |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Data e hora de entrega previstas |
|
iOS
|
data.tracking.ios | array of |
iOS |
|
Observação
|
data.tracking.note | string |
Observações |
|
order_id
|
data.tracking.order_id | string |
ID da encomenda |
|
order_id_path
|
data.tracking.order_id_path | string |
Caminho do ID do pedido |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Código do país de origem no formato ISO 3 |
|
shipment_package_count
|
data.tracking.shipment_package_count | integer |
Número de pacotes na remessa |
|
shipment_pickup_date
|
data.tracking.shipment_pickup_date | string |
Data e hora de levantamento das encomendas |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Data e hora das encomendas entregues |
|
shipment_type
|
data.tracking.shipment_type | string |
Tipo de envio |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Peso da remessa |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unidade de peso da remessa |
|
signed_by
|
data.tracking.signed_by | string |
Assinado por |
|
SMEs
|
data.tracking.smses | array of |
SMS |
|
origem
|
data.tracking.source | string |
Fonte |
|
etiqueta
|
data.tracking.tag | string |
Etiquetas |
|
subtag
|
data.tracking.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.subtag_message | string |
Mensagens de subtag |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Número de vezes rastreadas |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | string |
O rastreamento da última milha é suportado |
|
linguagem
|
data.tracking.language | string |
Linguagem |
|
unique_token
|
data.tracking.unique_token | string |
Token único |
|
pontos de controlo
|
data.tracking.checkpoints | array of object |
pontos de controlo |
|
lesma
|
data.tracking.checkpoints.slug | string |
Nome do Correio |
|
city
|
data.tracking.checkpoints.city | string |
City |
|
criado_em
|
data.tracking.checkpoints.created_at | string |
Data e hora de criação |
|
localização
|
data.tracking.checkpoints.location | string |
Localização |
|
country_name
|
data.tracking.checkpoints.country_name | string |
Nome do país |
|
mensagem
|
data.tracking.checkpoints.message | string |
Message |
|
country_iso3
|
data.tracking.checkpoints.country_iso3 | string |
Código do país em formato ISO 3 |
|
etiqueta
|
data.tracking.checkpoints.tag | string |
Etiquetas |
|
subtag
|
data.tracking.checkpoints.subtag | string |
Sub tags |
|
subtag_message
|
data.tracking.checkpoints.subtag_message | string |
Mensagens de subtag |
|
checkpoint_time
|
data.tracking.checkpoints.checkpoint_time | string |
Ponto de verificação do tempo alcançado |
|
coordenadas
|
data.tracking.checkpoints.coordinates | array of |
Coordenadas |
|
state
|
data.tracking.checkpoints.state | string |
Estado |
|
ZIP
|
data.tracking.checkpoints.zip | string |
Código postal |
|
raw_tag
|
data.tracking.checkpoints.raw_tag | string |
Tags brutas |
|
subscribed_smses
|
data.tracking.subscribed_smses | array of |
subscribed_smses |
|
subscribed_emails
|
data.tracking.subscribed_emails | array of |
subscribed_emails |
|
return_to_sender
|
data.tracking.return_to_sender | boolean |
return_to_sender |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
order_promised_delivery_date
|
data.tracking.order_promised_delivery_date | string |
order_promised_delivery_date |
|
delivery_type
|
data.tracking.delivery_type | string |
delivery_type |
|
pickup_location
|
data.tracking.pickup_location | string |
pickup_location |
|
pickup_note
|
data.tracking.pickup_note | string |
pickup_note |
|
courier_tracking_link
|
data.tracking.courier_tracking_link | string |
courier_tracking_link |
|
courier_redirect_link
|
data.tracking.courier_redirect_link | string |
courier_redirect_link |
|
first_attempted_at
|
data.tracking.first_attempted_at | string |
first_attempted_at |
Rastrear novamente um rastreamento expirado
Rastreie novamente um rastreamento expirado. Máximo de 3 vezes por rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
mensagem
|
meta.message | string |
Message |
|
tipo
|
meta.type | string |
tipo |
|
id
|
data.tracking.id | string |
ID |
|
tracking_number
|
data.tracking.tracking_number | string |
Número de rastreamento |
|
lesma
|
data.tracking.slug | string |
Nome do Correio |
|
tracking_account_number
|
data.tracking.tracking_account_number | string |
tracking_account_number |
|
tracking_origin_country
|
data.tracking.tracking_origin_country | string |
tracking_origin_country |
|
tracking_destination_country
|
data.tracking.tracking_destination_country | string |
tracking_destination_country |
|
tracking_key
|
data.tracking.tracking_key | string |
tracking_key |
|
tracking_postal_code
|
data.tracking.tracking_postal_code | string |
tracking_postal_code |
|
tracking_ship_date
|
data.tracking.tracking_ship_date | string |
tracking_ship_date |
|
tracking_state
|
data.tracking.tracking_state | string |
tracking_state |
|
active
|
data.tracking.active | boolean |
Rastreamento ativo ou inativo |
Receba todos os estafetas
Devolva uma lista de todos os estafetas.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
total
|
data.total | integer |
total |
|
estafetas
|
data.couriers | array of object |
Informação dos estafetas |
|
lesma
|
data.couriers.slug | string |
Nome do Correio |
|
nome
|
data.couriers.name | string |
Nome |
|
phone
|
data.couriers.phone | string |
Número de telefone |
|
other_name
|
data.couriers.other_name | string |
Nome alternativo |
|
web_url
|
data.couriers.web_url | string |
URL do site |
|
required_fields
|
data.couriers.required_fields | array of |
Campos obrigatórios |
|
optional_fields
|
data.couriers.optional_fields | array of |
Campos opcionais |
Remover uma notificação
Remova os recetores de notificação de um número de rastreamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de rastreamento
|
tracking_number | True | string |
Insira o número de rastreamento |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código
|
meta.code | integer |
código |
|
E-mails
|
data.notification.emails | array of |
Endereços de e-mail |
|
SMEs
|
data.notification.smses | array of string |
SMS |