AfterShip (Editor Independente) (versão prévia)
AfterShip é uma solução de acompanhamento de remessa. Ele faz parceria com mais de 900 transportadoras em todo o mundo, incluindo serviços populares como FedEx, DHL etc. Esse conector permite que um usuário acompanhe e receba notificações sobre remessas e integre-se a outros serviços, como o Dynamics 365 e serviços de terceiros, para fortalecer seu comércio eletrônico ou simplificar seus processos comerciais internos.
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 | Taiki Yoshida |
| URL | https://memo.tyoshida.me/power-platform/connectors/aftership-connector/ |
| tayoshi@microsoft.com |
| Metadados do conector | |
|---|---|
| Publicador | Taiki Yoshida |
| Site | https://www.aftership.com |
| Política de privacidade | https://www.automizely.com/legal/privacy |
| Categorias | Commerce |
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 |
|---|---|---|---|
| Chave de API | secureString | A chave da API de aplicativo/assinatura emitida pelo AfterShip | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar uma notificação |
Adicione receptores de notificação a um número de acompanhamento. |
| Atualizar um acompanhamento |
Atualize um acompanhamento. |
| Criar acompanhamento |
Crie um acompanhamento. |
| Detectar entregador |
Retorne uma lista de entregadores correspondentes com base no formato de número de rastreamento e entregadores selecionados ou uma lista de entregadores. |
| Excluir um acompanhamento |
Excluir um acompanhamento. |
| Marcar o acompanhamento conforme concluído |
Marque um acompanhamento como concluído. O rastreamento não será atualizado automaticamente até que ele seja rastreado novamente. |
| Obter acompanhamentos |
Obtenha resultados de acompanhamento de vários acompanhamentos. |
| Obter entregadores ativados pelo usuário |
Retorne uma lista de entregadores ativados em sua conta do AfterShip. |
| Obter notificação de acompanhamento |
Obtenha informações de contato para os usuários notificarem quando o controle for alterado. Observe que somente os receptores do cliente serão retornados. Qualquer |
| Obter o último ponto de verificação |
Retorne as informações de acompanhamento do último ponto de verificação de um único acompanhamento. |
| Obter todos os entregadores |
Retorne uma lista de todos os entregadores. |
| Obter um acompanhamento |
Obtenha resultados de acompanhamento de um único acompanhamento. |
| Rastrear novamente um acompanhamento expirado |
Rastrear novamente um acompanhamento expirado. Máximo de 3 vezes por rastreamento. |
| Remover uma notificação |
Remova os receptores de notificação de um número de acompanhamento. |
Adicionar uma notificação
Adicione receptores de notificação a um número de acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
e-mails
|
data.notification.emails | array of |
Endereços de email |
|
smses
|
data.notification.smses | array of string |
SMS |
Atualizar um acompanhamento
Atualize um acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
|
title
|
title | string |
title |
|
|
nota
|
note | string |
Anotações |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
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 acompanhamento |
|
lesma
|
data.tracking.slug | string |
Nome do Mensageiro |
|
ativo
|
data.tracking.active | boolean |
Acompanhamento ativo ou inativo |
|
android
|
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 da entrega |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Código do país de destino no formato ISO 3 |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Código do país courier no formato ISO 3 |
|
e-mails
|
data.tracking.emails | array of |
Endereços de email |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Data e hora de entrega esperadas |
|
Ios
|
data.tracking.ios | array of |
iOS |
|
nota
|
data.tracking.note | string |
Anotações |
|
order_id
|
data.tracking.order_id | string |
ID do pedido |
|
order_id_path
|
data.tracking.order_id_path | string |
Caminho da ID do pedido |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Código de 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 dos pacotes coletados |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Data e hora dos pacotes entregues |
|
shipment_type
|
data.tracking.shipment_type | string |
Tipo de remessa |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Peso da remessa |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unidade de peso de remessa |
|
signed_by
|
data.tracking.signed_by | string |
Assinado por |
|
smses
|
data.tracking.smses | array of |
SMS |
|
fonte
|
data.tracking.source | string |
Source |
|
marca
|
data.tracking.tag | string |
Etiquetas |
|
subtag
|
data.tracking.subtag | string |
Submarcas |
|
subtag_message
|
data.tracking.subtag_message | string |
Submarca mensagens |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Número de vezes controladas |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | string |
Há suporte para o rastreamento de última milha |
|
linguagem
|
data.tracking.language | string |
Linguagem |
|
unique_token
|
data.tracking.unique_token | string |
Token exclusivo |
|
Checkpoints
|
data.tracking.checkpoints | array of object |
Checkpoints |
|
lesma
|
data.tracking.checkpoints.slug | string |
Nome do Mensageiro |
|
city
|
data.tracking.checkpoints.city | string |
City |
|
criado_em
|
data.tracking.checkpoints.created_at | string |
Data e hora de criação |
|
local
|
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 no formato ISO 3 |
|
marca
|
data.tracking.checkpoints.tag | string |
Etiquetas |
|
subtag
|
data.tracking.checkpoints.subtag | string |
Submarcas |
|
subtag_message
|
data.tracking.checkpoints.subtag_message | string |
Submarca mensagens |
|
checkpoint_time
|
data.tracking.checkpoints.checkpoint_time | string |
Ponto de verificação atingido pelo tempo |
|
Coordenadas
|
data.tracking.checkpoints.coordinates | array of |
Coordenadas |
|
estado
|
data.tracking.checkpoints.state | string |
Estado |
|
zip
|
data.tracking.checkpoints.zip | string |
CEP |
|
raw_tag
|
data.tracking.checkpoints.raw_tag | string |
Marcas 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 acompanhamento
Crie um acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
lesma
|
slug | string |
Nome do Mensageiro |
|
|
tracking_number
|
tracking_number | string |
Número de acompanhamento |
|
|
title
|
title | string |
title |
|
|
smses
|
smses | array of |
SMS |
|
|
e-mails
|
emails | array of |
Endereços de email |
|
|
order_id
|
order_id | string |
ID do pedido |
|
|
order_id_path
|
order_id_path | string |
Caminho da 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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
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 acompanhamento |
|
lesma
|
data.tracking.slug | string |
Nome do Mensageiro |
|
ativo
|
data.tracking.active | boolean |
Acompanhamento ativo ou inativo |
|
android
|
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 da entrega |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Código do país de destino no formato ISO 3 |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Código do país courier no formato ISO 3 |
|
e-mails
|
data.tracking.emails | array of |
Endereços de email |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Data e hora de entrega esperadas |
|
Ios
|
data.tracking.ios | array of |
iOS |
|
nota
|
data.tracking.note | string |
Anotações |
|
order_id
|
data.tracking.order_id | string |
ID do pedido |
|
order_id_path
|
data.tracking.order_id_path | string |
Caminho da ID do pedido |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Código de 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 dos pacotes coletados |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Data e hora dos pacotes entregues |
|
shipment_type
|
data.tracking.shipment_type | string |
Tipo de remessa |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Peso da remessa |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unidade de peso de remessa |
|
signed_by
|
data.tracking.signed_by | string |
Assinado por |
|
smses
|
data.tracking.smses | array of |
SMS |
|
fonte
|
data.tracking.source | string |
Source |
|
marca
|
data.tracking.tag | string |
Etiquetas |
|
subtag
|
data.tracking.subtag | string |
Submarcas |
|
subtag_message
|
data.tracking.subtag_message | string |
Submarca mensagens |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Número de vezes controladas |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | boolean |
Há suporte para o rastreamento de última milha |
|
linguagem
|
data.tracking.language | string |
Linguagem |
|
unique_token
|
data.tracking.unique_token | string |
Token exclusivo |
|
Checkpoints
|
data.tracking.checkpoints | array of |
Checkpoints |
|
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 |
Detectar entregador
Retorne uma lista de entregadores correspondentes com base no formato de número de rastreamento e entregadores selecionados ou uma lista de entregadores.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
tracking_number
|
tracking_number | string |
Número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
total
|
data.total | integer |
total |
|
Correios
|
data.couriers | array of object |
Informações dos couriers |
|
lesma
|
data.couriers.slug | string |
Nome do Mensageiro |
|
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 com suporte |
|
service_from_country_iso3
|
data.couriers.service_from_country_iso3 | array of string |
Código do país do serviço no formato ISO3 |
Excluir um acompanhamento
Excluir um acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
id
|
data.tracking.id | string |
ID |
|
tracking_number
|
data.tracking.tracking_number | string |
Número de acompanhamento |
|
lesma
|
data.tracking.slug | string |
Nome do Mensageiro |
|
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 conforme concluído
Marque um acompanhamento como concluído. O rastreamento não será atualizado automaticamente até que ele seja rastreado novamente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
|
reason
|
reason | string |
reason |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
mensagem
|
meta.message | string |
Message |
|
tipo
|
meta.type | string |
tipo |
Obter acompanhamentos
Obtenha resultados de acompanhamento de vários acompanhamentos.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
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 Mensageiro |
|
origem
|
data.origin | array of |
origem |
|
destino
|
data.destination | array of |
destino |
|
marca
|
data.tag | string |
Etiquetas |
|
fields
|
data.fields | string |
fields |
|
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 courier no formato ISO 3 |
|
acompanhamentos
|
data.trackings | array of object |
acompanhamentos |
|
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 acompanhamento |
|
lesma
|
data.trackings.slug | string |
Nome do Mensageiro |
|
ativo
|
data.trackings.active | boolean |
Acompanhamento ativo ou inativo |
|
android
|
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 da entrega |
|
destination_country_iso3
|
data.trackings.destination_country_iso3 | string |
Código do país de destino no formato ISO 3 |
|
courier_destination_country_iso3
|
data.trackings.courier_destination_country_iso3 | string |
Código do país courier no formato ISO 3 |
|
e-mails
|
data.trackings.emails | array of string |
Endereços de email |
|
expected_delivery
|
data.trackings.expected_delivery | string |
Data e hora de entrega esperadas |
|
Ios
|
data.trackings.ios | array of |
iOS |
|
nota
|
data.trackings.note | string |
Anotações |
|
order_id
|
data.trackings.order_id | string |
ID do pedido |
|
order_id_path
|
data.trackings.order_id_path | string |
Caminho da ID do pedido |
|
origin_country_iso3
|
data.trackings.origin_country_iso3 | string |
Código de 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 dos pacotes coletados |
|
shipment_delivery_date
|
data.trackings.shipment_delivery_date | string |
Data e hora dos pacotes entregues |
|
shipment_type
|
data.trackings.shipment_type | string |
Tipo de remessa |
|
shipment_weight
|
data.trackings.shipment_weight | string |
Peso da remessa |
|
shipment_weight_unit
|
data.trackings.shipment_weight_unit | string |
Unidade de peso de remessa |
|
signed_by
|
data.trackings.signed_by | string |
Assinado por |
|
smses
|
data.trackings.smses | array of string |
SMS |
|
fonte
|
data.trackings.source | string |
Source |
|
marca
|
data.trackings.tag | string |
Etiquetas |
|
subtag
|
data.trackings.subtag | string |
Submarcas |
|
subtag_message
|
data.trackings.subtag_message | string |
Submarca mensagens |
|
title
|
data.trackings.title | string |
title |
|
tracked_count
|
data.trackings.tracked_count | integer |
Número de vezes controladas |
|
last_mile_tracking_supported
|
data.trackings.last_mile_tracking_supported | string |
Há suporte para o rastreamento de última milha |
|
linguagem
|
data.trackings.language | string |
Linguagem |
|
unique_token
|
data.trackings.unique_token | string |
Token exclusivo |
|
Checkpoints
|
data.trackings.checkpoints | array of object |
Checkpoints |
|
lesma
|
data.trackings.checkpoints.slug | string |
Nome do Mensageiro |
|
city
|
data.trackings.checkpoints.city | string |
City |
|
criado_em
|
data.trackings.checkpoints.created_at | string |
Data e hora de criação |
|
local
|
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 no formato ISO 3 |
|
marca
|
data.trackings.checkpoints.tag | string |
Etiquetas |
|
subtag
|
data.trackings.checkpoints.subtag | string |
Submarcas |
|
subtag_message
|
data.trackings.checkpoints.subtag_message | string |
Submarca mensagens |
|
checkpoint_time
|
data.trackings.checkpoints.checkpoint_time | string |
Ponto de verificação atingido pelo tempo |
|
Coordenadas
|
data.trackings.checkpoints.coordinates | array of |
Coordenadas |
|
estado
|
data.trackings.checkpoints.state | string |
Estado |
|
zip
|
data.trackings.checkpoints.zip | string |
CEP |
|
raw_tag
|
data.trackings.checkpoints.raw_tag | string |
Marcas 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 entregadores ativados pelo usuário
Retorne uma lista de entregadores ativados em sua conta do AfterShip.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
total
|
data.total | integer |
total |
|
Correios
|
data.couriers | array of object |
Informações dos couriers |
|
lesma
|
data.couriers.slug | string |
Nome do Mensageiro |
|
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 com suporte |
|
service_from_country_iso3
|
data.couriers.service_from_country_iso3 | array of string |
Código do país do serviço no formato ISO3 |
Obter notificação de acompanhamento
Obtenha informações de contato para os usuários notificarem quando o controle for alterado. Observe que somente os receptores do cliente serão retornados. Qualquer email, sms ou webhook que pertence à Loja não será retornado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
e-mails
|
data.notification.emails | array of |
Endereços de email |
|
smses
|
data.notification.smses | array of string |
SMS |
Obter o último ponto de verificação
Retorne as informações de acompanhamento do último ponto de verificação de um único acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
id
|
data.id | string |
ID |
|
tracking_number
|
data.tracking_number | string |
Número de acompanhamento |
|
lesma
|
data.slug | string |
Nome do Mensageiro |
|
marca
|
data.tag | string |
Etiquetas |
|
subtag
|
data.subtag | string |
Submarcas |
|
subtag_message
|
data.subtag_message | string |
Submarca mensagens |
|
lesma
|
data.checkpoint.slug | string |
Nome do Mensageiro |
|
criado_em
|
data.checkpoint.created_at | string |
Data e hora de criação |
|
checkpoint_time
|
data.checkpoint.checkpoint_time | string |
Ponto de verificação atingido pelo tempo |
|
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 no formato ISO 3 |
|
country_name
|
data.checkpoint.country_name | string |
Nome do país |
|
mensagem
|
data.checkpoint.message | string |
Message |
|
estado
|
data.checkpoint.state | string |
Estado |
|
marca
|
data.checkpoint.tag | string |
Etiquetas |
|
subtag
|
data.checkpoint.subtag | string |
Submarcas |
|
subtag_message
|
data.checkpoint.subtag_message | string |
Submarca mensagens |
|
zip
|
data.checkpoint.zip | string |
CEP |
|
raw_tag
|
data.checkpoint.raw_tag | string |
Marcas brutas |
Obter todos os entregadores
Retorne uma lista de todos os entregadores.
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
total
|
data.total | integer |
total |
|
Correios
|
data.couriers | array of object |
Informações dos couriers |
|
lesma
|
data.couriers.slug | string |
Nome do Mensageiro |
|
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 |
Obter um acompanhamento
Obtenha resultados de acompanhamento de um único acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
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 acompanhamento |
|
lesma
|
data.tracking.slug | string |
Nome do Mensageiro |
|
ativo
|
data.tracking.active | boolean |
Acompanhamento ativo ou inativo |
|
android
|
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 da entrega |
|
destination_country_iso3
|
data.tracking.destination_country_iso3 | string |
Código do país de destino no formato ISO 3 |
|
courier_destination_country_iso3
|
data.tracking.courier_destination_country_iso3 | string |
Código do país courier no formato ISO 3 |
|
e-mails
|
data.tracking.emails | array of |
Endereços de email |
|
expected_delivery
|
data.tracking.expected_delivery | string |
Data e hora de entrega esperadas |
|
Ios
|
data.tracking.ios | array of |
iOS |
|
nota
|
data.tracking.note | string |
Anotações |
|
order_id
|
data.tracking.order_id | string |
ID do pedido |
|
order_id_path
|
data.tracking.order_id_path | string |
Caminho da ID do pedido |
|
origin_country_iso3
|
data.tracking.origin_country_iso3 | string |
Código de 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 dos pacotes coletados |
|
shipment_delivery_date
|
data.tracking.shipment_delivery_date | string |
Data e hora dos pacotes entregues |
|
shipment_type
|
data.tracking.shipment_type | string |
Tipo de remessa |
|
shipment_weight
|
data.tracking.shipment_weight | integer |
Peso da remessa |
|
shipment_weight_unit
|
data.tracking.shipment_weight_unit | string |
Unidade de peso de remessa |
|
signed_by
|
data.tracking.signed_by | string |
Assinado por |
|
smses
|
data.tracking.smses | array of |
SMS |
|
fonte
|
data.tracking.source | string |
Source |
|
marca
|
data.tracking.tag | string |
Etiquetas |
|
subtag
|
data.tracking.subtag | string |
Submarcas |
|
subtag_message
|
data.tracking.subtag_message | string |
Submarca mensagens |
|
title
|
data.tracking.title | string |
title |
|
tracked_count
|
data.tracking.tracked_count | integer |
Número de vezes controladas |
|
last_mile_tracking_supported
|
data.tracking.last_mile_tracking_supported | string |
Há suporte para o rastreamento de última milha |
|
linguagem
|
data.tracking.language | string |
Linguagem |
|
unique_token
|
data.tracking.unique_token | string |
Token exclusivo |
|
Checkpoints
|
data.tracking.checkpoints | array of object |
Checkpoints |
|
lesma
|
data.tracking.checkpoints.slug | string |
Nome do Mensageiro |
|
city
|
data.tracking.checkpoints.city | string |
City |
|
criado_em
|
data.tracking.checkpoints.created_at | string |
Data e hora de criação |
|
local
|
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 no formato ISO 3 |
|
marca
|
data.tracking.checkpoints.tag | string |
Etiquetas |
|
subtag
|
data.tracking.checkpoints.subtag | string |
Submarcas |
|
subtag_message
|
data.tracking.checkpoints.subtag_message | string |
Submarca mensagens |
|
checkpoint_time
|
data.tracking.checkpoints.checkpoint_time | string |
Ponto de verificação atingido pelo tempo |
|
Coordenadas
|
data.tracking.checkpoints.coordinates | array of |
Coordenadas |
|
estado
|
data.tracking.checkpoints.state | string |
Estado |
|
zip
|
data.tracking.checkpoints.zip | string |
CEP |
|
raw_tag
|
data.tracking.checkpoints.raw_tag | string |
Marcas 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 acompanhamento expirado
Rastrear novamente um acompanhamento expirado. Máximo de 3 vezes por rastreamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
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 acompanhamento |
|
lesma
|
data.tracking.slug | string |
Nome do Mensageiro |
|
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 |
|
ativo
|
data.tracking.active | boolean |
Acompanhamento ativo ou inativo |
Remover uma notificação
Remova os receptores de notificação de um número de acompanhamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Lesma de correio
|
slug | True | string |
Lesma de correio |
|
Número de acompanhamento
|
tracking_number | True | string |
Insira o número de acompanhamento |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
codificar
|
meta.code | integer |
codificar |
|
e-mails
|
data.notification.emails | array of |
Endereços de email |
|
smses
|
data.notification.smses | array of string |
SMS |