AfterShip (независимый издатель) (предварительная версия)

AfterShip — это решение для отслеживания поставок. Она сотрудничает с более чем 900 перевозчиками по всему миру, включая популярные услуги, такие как FedEx, DHL и т. д. Этот соединитель позволяет пользователю отслеживать и получать уведомления о поставках и интегрироваться с другими службами, такими как Dynamics 365 и сторонние службы для укрепления электронной коммерции или оптимизации внутренних бизнес-процессов.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Тайки Йошида
URL https://memo.tyoshida.me/power-platform/connectors/aftership-connector/
Адрес электронной почты tayoshi@microsoft.com
Метаданные соединителя
Publisher Тайки Йошида
Веб-сайт https://www.aftership.com
Политика конфиденциальности https://www.automizely.com/legal/privacy
Категории Commerce

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API приложения или подписки, выданный AfterShip True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Восстановление отслеживания истекшим сроком действия

Повторное отслеживание с истекшим сроком действия. Максимум 3 раза за отслеживание.
Добавление уведомления

Добавьте получателей уведомлений в номер отслеживания.
Обнаружение курьера

Возвращает список сопоставленных курьеров на основе формата номера отслеживания и выбранных курьеров или списка курьеров .
Обновление отслеживания

Обновление отслеживания.
Получение активированных пользователем курьеров

Возвращает список курьеров, активированных в учетной записи AfterShip.
Получение всех курьеров

Возвращает список всех курьеров.
Получение отслеживания

Получение результатов отслеживания одного отслеживания.
Получение отслеживания

Получение результатов отслеживания нескольких отслеживаний.
Получение последней контрольной точки

Возвращает сведения об отслеживании последней контрольной точки одного отслеживания.
Получение уведомления об отслеживании

Получите контактные данные для пользователей, чтобы уведомить об изменениях отслеживания. Обратите внимание, что будут возвращены только получатели клиентов. Любой emailобъект или smswebhook который принадлежит Магазину, не будет возвращен.
Пометить отслеживание как завершенное

Пометьте отслеживание как завершенное. Отслеживание не будет автоматически обновляться, пока не перенастроит его.
Создание отслеживания

Создайте отслеживание.
Удаление отслеживания

Удаление отслеживания.
Удаление уведомления

Удалите получателей уведомлений из номера отслеживания.

Восстановление отслеживания истекшим сроком действия

Идентификатор операции:
RetrackAnExpiredTracking

Повторное отслеживание с истекшим сроком действия. Максимум 3 раза за отслеживание.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
сообщение
 meta.message string

Message
type
 meta.type string

type
id
 data.tracking.id string

Идентификатор
tracking_number
 data.tracking.tracking_number string

Номер отслеживания
слизняк
 data.tracking.slug string

Имя курьера
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
активный
 data.tracking.active boolean

Активное или неактивное отслеживание

Добавление уведомления

Идентификатор операции:
AddANotification

Добавьте получателей уведомлений в номер отслеживания.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
сообщения электронной почты
 data.notification.emails array of

Адреса электронной почты
smses
 data.notification.smses array of string

СМС

Обнаружение курьера

Идентификатор операции:
DetectCourier

Возвращает список сопоставленных курьеров на основе формата номера отслеживания и выбранных курьеров или списка курьеров .

Параметры

Имя Ключ Обязательно Тип Описание
tracking_number
 tracking_number string

Номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
итог
 data.total integer

итог
Курьеров
 data.couriers array of object

Сведения о курьерах
слизняк
 data.couriers.slug string

Имя курьера
имя
 data.couriers.name string

Имя
phone
 data.couriers.phone string

Номер телефона
other_name
 data.couriers.other_name string

Альтернативное имя
web_url
 data.couriers.web_url string

URL-адрес веб-сайта
required_fields
 data.couriers.required_fields array of string

Обязательные поля
optional_fields
 data.couriers.optional_fields array of string

Необязательные поля
default_language
 data.couriers.default_language string

Язык по умолчанию
support_languages
 data.couriers.support_languages array of string

Поддерживаемые языки
service_from_country_iso3
 data.couriers.service_from_country_iso3 array of string

Код страны службы в формате ISO3

Обновление отслеживания

Идентификатор операции:
UpdateATracking

Обновление отслеживания.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания
title
 title string

title
заметка
 note string

Примечания.

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
id
 data.tracking.id string

Идентификатор
создано_в
 data.tracking.created_at string

Дата и время создания
updated_at
 data.tracking.updated_at string

Обновленная дата и время
last_updated_at
 data.tracking.last_updated_at string

Дата и время последнего обновления
tracking_number
 data.tracking.tracking_number string

Номер отслеживания
слизняк
 data.tracking.slug string

Имя курьера
активный
 data.tracking.active boolean

Активное или неактивное отслеживание
андроид
 data.tracking.android array of

Андроид
custom_fields
 data.tracking.custom_fields string

Пользовательские поля
customer_name
 data.tracking.customer_name string

Имя клиента
delivery_time
 data.tracking.delivery_time integer

Дата и время доставки
destination_country_iso3
 data.tracking.destination_country_iso3 string

Код страны назначения в формате ISO 3
courier_destination_country_iso3
 data.tracking.courier_destination_country_iso3 string

Код страны-курьера в формате ISO 3
сообщения электронной почты
 data.tracking.emails array of

Адреса электронной почты
expected_delivery
 data.tracking.expected_delivery string

Ожидаемая дата и время доставки
ios
 data.tracking.ios array of

iOS
заметка
 data.tracking.note string

Примечания.
order_id
 data.tracking.order_id string

Идентификатор заказа
order_id_path
 data.tracking.order_id_path string

Путь к идентификатору заказа
origin_country_iso3
 data.tracking.origin_country_iso3 string

Исходный код страны в формате ISO 3
shipment_package_count
 data.tracking.shipment_package_count integer

Количество пакетов в доставке
shipment_pickup_date
 data.tracking.shipment_pickup_date string

Дата и время выбранных пакетов
shipment_delivery_date
 data.tracking.shipment_delivery_date string

Дата и время доставки пакетов
shipment_type
 data.tracking.shipment_type string

Тип отгрузки
shipment_weight
 data.tracking.shipment_weight integer

Вес отгрузки
shipment_weight_unit
 data.tracking.shipment_weight_unit string

Единица веса отгрузки
signed_by
 data.tracking.signed_by string

Подписан
smses
 data.tracking.smses array of

СМС
source
 data.tracking.source string

Исходный материал
tag
 data.tracking.tag string

Метки
вложенный тег
 data.tracking.subtag string

Вложенные теги
subtag_message
 data.tracking.subtag_message string

Сообщения вложенных тегов
title
 data.tracking.title string

title
tracked_count
 data.tracking.tracked_count integer

Количество отслеживаемых операций
last_mile_tracking_supported
 data.tracking.last_mile_tracking_supported string

Отслеживание последней мили поддерживается
language
 data.tracking.language string

Language
unique_token
 data.tracking.unique_token string

Уникальный маркер
Контрольные точки
 data.tracking.checkpoints array of object

Контрольные точки
слизняк
 data.tracking.checkpoints.slug string

Имя курьера
city
 data.tracking.checkpoints.city string

Город
создано_в
 data.tracking.checkpoints.created_at string

Дата и время создания
location
 data.tracking.checkpoints.location string

Местоположение
country_name
 data.tracking.checkpoints.country_name string

Имя страны
сообщение
 data.tracking.checkpoints.message string

Message
country_iso3
 data.tracking.checkpoints.country_iso3 string

Код страны в формате ISO 3
tag
 data.tracking.checkpoints.tag string

Метки
вложенный тег
 data.tracking.checkpoints.subtag string

Вложенные теги
subtag_message
 data.tracking.checkpoints.subtag_message string

Сообщения вложенных тегов
checkpoint_time
 data.tracking.checkpoints.checkpoint_time string

Время достижения контрольной точки
Координаты
 data.tracking.checkpoints.coordinates array of

Координаты
государство
 data.tracking.checkpoints.state string

Государство
ZIP-архив
 data.tracking.checkpoints.zip string

Почтовый индекс
raw_tag
 data.tracking.checkpoints.raw_tag string

Необработанные теги
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

Получение активированных пользователем курьеров

Идентификатор операции:
GetUserActivatedCouriers

Возвращает список курьеров, активированных в учетной записи AfterShip.

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
итог
 data.total integer

итог
Курьеров
 data.couriers array of object

Сведения о курьерах
слизняк
 data.couriers.slug string

Имя курьера
имя
 data.couriers.name string

Имя
phone
 data.couriers.phone string

Номер телефона
other_name
 data.couriers.other_name string

Альтернативное имя
web_url
 data.couriers.web_url string

URL-адрес веб-сайта
required_fields
 data.couriers.required_fields array of string

Обязательные поля
optional_fields
 data.couriers.optional_fields array of string

Необязательные поля
default_language
 data.couriers.default_language string

Язык по умолчанию
support_languages
 data.couriers.support_languages array of string

Поддерживаемые языки
service_from_country_iso3
 data.couriers.service_from_country_iso3 array of string

Код страны службы в формате ISO3

Получение всех курьеров

Идентификатор операции:
GetAllCouriers

Возвращает список всех курьеров.

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
итог
 data.total integer

итог
Курьеров
 data.couriers array of object

Сведения о курьерах
слизняк
 data.couriers.slug string

Имя курьера
имя
 data.couriers.name string

Имя
phone
 data.couriers.phone string

Номер телефона
other_name
 data.couriers.other_name string

Альтернативное имя
web_url
 data.couriers.web_url string

URL-адрес веб-сайта
required_fields
 data.couriers.required_fields array of

Обязательные поля
optional_fields
 data.couriers.optional_fields array of

Необязательные поля

Получение отслеживания

Идентификатор операции:
GetATracking

Получение результатов отслеживания одного отслеживания.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
id
 data.tracking.id string

Идентификатор
создано_в
 data.tracking.created_at string

Дата и время создания
updated_at
 data.tracking.updated_at string

Обновленная дата и время
last_updated_at
 data.tracking.last_updated_at string

Дата и время последнего обновления
tracking_number
 data.tracking.tracking_number string

Номер отслеживания
слизняк
 data.tracking.slug string

Имя курьера
активный
 data.tracking.active boolean

Активное или неактивное отслеживание
андроид
 data.tracking.android array of

Андроид
custom_fields
 data.tracking.custom_fields string

Пользовательские поля
customer_name
 data.tracking.customer_name string

Имя клиента
delivery_time
 data.tracking.delivery_time integer

Дата и время доставки
destination_country_iso3
 data.tracking.destination_country_iso3 string

Код страны назначения в формате ISO 3
courier_destination_country_iso3
 data.tracking.courier_destination_country_iso3 string

Код страны-курьера в формате ISO 3
сообщения электронной почты
 data.tracking.emails array of

Адреса электронной почты
expected_delivery
 data.tracking.expected_delivery string

Ожидаемая дата и время доставки
ios
 data.tracking.ios array of

iOS
заметка
 data.tracking.note string

Примечания.
order_id
 data.tracking.order_id string

Идентификатор заказа
order_id_path
 data.tracking.order_id_path string

Путь к идентификатору заказа
origin_country_iso3
 data.tracking.origin_country_iso3 string

Исходный код страны в формате ISO 3
shipment_package_count
 data.tracking.shipment_package_count integer

Количество пакетов в доставке
shipment_pickup_date
 data.tracking.shipment_pickup_date string

Дата и время выбранных пакетов
shipment_delivery_date
 data.tracking.shipment_delivery_date string

Дата и время доставки пакетов
shipment_type
 data.tracking.shipment_type string

Тип отгрузки
shipment_weight
 data.tracking.shipment_weight integer

Вес отгрузки
shipment_weight_unit
 data.tracking.shipment_weight_unit string

Единица веса отгрузки
signed_by
 data.tracking.signed_by string

Подписан
smses
 data.tracking.smses array of

СМС
source
 data.tracking.source string

Исходный материал
tag
 data.tracking.tag string

Метки
вложенный тег
 data.tracking.subtag string

Вложенные теги
subtag_message
 data.tracking.subtag_message string

Сообщения вложенных тегов
title
 data.tracking.title string

title
tracked_count
 data.tracking.tracked_count integer

Количество отслеживаемых операций
last_mile_tracking_supported
 data.tracking.last_mile_tracking_supported string

Отслеживание последней мили поддерживается
language
 data.tracking.language string

Language
unique_token
 data.tracking.unique_token string

Уникальный маркер
Контрольные точки
 data.tracking.checkpoints array of object

Контрольные точки
слизняк
 data.tracking.checkpoints.slug string

Имя курьера
city
 data.tracking.checkpoints.city string

Город
создано_в
 data.tracking.checkpoints.created_at string

Дата и время создания
location
 data.tracking.checkpoints.location string

Местоположение
country_name
 data.tracking.checkpoints.country_name string

Имя страны
сообщение
 data.tracking.checkpoints.message string

Message
country_iso3
 data.tracking.checkpoints.country_iso3 string

Код страны в формате ISO 3
tag
 data.tracking.checkpoints.tag string

Метки
вложенный тег
 data.tracking.checkpoints.subtag string

Вложенные теги
subtag_message
 data.tracking.checkpoints.subtag_message string

Сообщения вложенных тегов
checkpoint_time
 data.tracking.checkpoints.checkpoint_time string

Время достижения контрольной точки
Координаты
 data.tracking.checkpoints.coordinates array of

Координаты
государство
 data.tracking.checkpoints.state string

Государство
ZIP-архив
 data.tracking.checkpoints.zip string

Почтовый индекс
raw_tag
 data.tracking.checkpoints.raw_tag string

Необработанные теги
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

Получение отслеживания

Идентификатор операции:
GetTrackings

Получение результатов отслеживания нескольких отслеживаний.

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
page
 data.page integer

page
limit
 data.limit integer

limit
count
 data.count integer

count
ключевое слово
 data.keyword string

ключевое слово
слизняк
 data.slug string

Имя курьера
origin
 data.origin array of

origin
destination
 data.destination array of

destination
tag
 data.tag string

Метки
столбцов
 data.fields string

столбцов
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

Дата и время последнего обновления
return_to_sender
 data.return_to_sender array of

return_to_sender
courier_destination_country_iso3
 data.courier_destination_country_iso3 array of

Код страны-курьера в формате ISO 3
отслеживание
 data.trackings array of object

отслеживание
id
 data.trackings.id string

Идентификатор
создано_в
 data.trackings.created_at string

Дата и время создания
updated_at
 data.trackings.updated_at string

Обновленная дата и время
last_updated_at
 data.trackings.last_updated_at string

Дата и время последнего обновления
tracking_number
 data.trackings.tracking_number string

Номер отслеживания
слизняк
 data.trackings.slug string

Имя курьера
активный
 data.trackings.active boolean

Активное или неактивное отслеживание
андроид
 data.trackings.android array of

Андроид
custom_fields
 data.trackings.custom_fields string

Пользовательские поля
customer_name
 data.trackings.customer_name string

Имя клиента
delivery_time
 data.trackings.delivery_time integer

Дата и время доставки
destination_country_iso3
 data.trackings.destination_country_iso3 string

Код страны назначения в формате ISO 3
courier_destination_country_iso3
 data.trackings.courier_destination_country_iso3 string

Код страны-курьера в формате ISO 3
сообщения электронной почты
 data.trackings.emails array of string

Адреса электронной почты
expected_delivery
 data.trackings.expected_delivery string

Ожидаемая дата и время доставки
ios
 data.trackings.ios array of

iOS
заметка
 data.trackings.note string

Примечания.
order_id
 data.trackings.order_id string

Идентификатор заказа
order_id_path
 data.trackings.order_id_path string

Путь к идентификатору заказа
origin_country_iso3
 data.trackings.origin_country_iso3 string

Исходный код страны в формате ISO 3
shipment_package_count
 data.trackings.shipment_package_count integer

Количество пакетов в доставке
shipment_pickup_date
 data.trackings.shipment_pickup_date string

Дата и время выбранных пакетов
shipment_delivery_date
 data.trackings.shipment_delivery_date string

Дата и время доставки пакетов
shipment_type
 data.trackings.shipment_type string

Тип отгрузки
shipment_weight
 data.trackings.shipment_weight string

Вес отгрузки
shipment_weight_unit
 data.trackings.shipment_weight_unit string

Единица веса отгрузки
signed_by
 data.trackings.signed_by string

Подписан
smses
 data.trackings.smses array of string

СМС
source
 data.trackings.source string

Исходный материал
tag
 data.trackings.tag string

Метки
вложенный тег
 data.trackings.subtag string

Вложенные теги
subtag_message
 data.trackings.subtag_message string

Сообщения вложенных тегов
title
 data.trackings.title string

title
tracked_count
 data.trackings.tracked_count integer

Количество отслеживаемых операций
last_mile_tracking_supported
 data.trackings.last_mile_tracking_supported string

Отслеживание последней мили поддерживается
language
 data.trackings.language string

Language
unique_token
 data.trackings.unique_token string

Уникальный маркер
Контрольные точки
 data.trackings.checkpoints array of object

Контрольные точки
слизняк
 data.trackings.checkpoints.slug string

Имя курьера
city
 data.trackings.checkpoints.city string

Город
создано_в
 data.trackings.checkpoints.created_at string

Дата и время создания
location
 data.trackings.checkpoints.location string

Местоположение
country_name
 data.trackings.checkpoints.country_name string

Имя страны
сообщение
 data.trackings.checkpoints.message string

Message
country_iso3
 data.trackings.checkpoints.country_iso3 string

Код страны в формате ISO 3
tag
 data.trackings.checkpoints.tag string

Метки
вложенный тег
 data.trackings.checkpoints.subtag string

Вложенные теги
subtag_message
 data.trackings.checkpoints.subtag_message string

Сообщения вложенных тегов
checkpoint_time
 data.trackings.checkpoints.checkpoint_time string

Время достижения контрольной точки
Координаты
 data.trackings.checkpoints.coordinates array of

Координаты
государство
 data.trackings.checkpoints.state string

Государство
ZIP-архив
 data.trackings.checkpoints.zip string

Почтовый индекс
raw_tag
 data.trackings.checkpoints.raw_tag string

Необработанные теги
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

Получение последней контрольной точки

Идентификатор операции:
GetLastCheckpoint

Возвращает сведения об отслеживании последней контрольной точки одного отслеживания.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
id
 data.id string

Идентификатор
tracking_number
 data.tracking_number string

Номер отслеживания
слизняк
 data.slug string

Имя курьера
tag
 data.tag string

Метки
вложенный тег
 data.subtag string

Вложенные теги
subtag_message
 data.subtag_message string

Сообщения вложенных тегов
слизняк
 data.checkpoint.slug string

Имя курьера
создано_в
 data.checkpoint.created_at string

Дата и время создания
checkpoint_time
 data.checkpoint.checkpoint_time string

Время достижения контрольной точки
city
 data.checkpoint.city string

Город
Координаты
 data.checkpoint.coordinates array of

Координаты
country_iso3
 data.checkpoint.country_iso3 string

Код страны в формате ISO 3
country_name
 data.checkpoint.country_name string

Имя страны
сообщение
 data.checkpoint.message string

Message
государство
 data.checkpoint.state string

Государство
tag
 data.checkpoint.tag string

Метки
вложенный тег
 data.checkpoint.subtag string

Вложенные теги
subtag_message
 data.checkpoint.subtag_message string

Сообщения вложенных тегов
ZIP-архив
 data.checkpoint.zip string

Почтовый индекс
raw_tag
 data.checkpoint.raw_tag string

Необработанные теги

Получение уведомления об отслеживании

Идентификатор операции:
GetTrackingNotification

Получите контактные данные для пользователей, чтобы уведомить об изменениях отслеживания. Обратите внимание, что будут возвращены только получатели клиентов. Любой emailобъект или smswebhook который принадлежит Магазину, не будет возвращен.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
сообщения электронной почты
 data.notification.emails array of

Адреса электронной почты
smses
 data.notification.smses array of string

СМС

Пометить отслеживание как завершенное

Идентификатор операции:
MarkTrackingAsCompleted

Пометьте отслеживание как завершенное. Отслеживание не будет автоматически обновляться, пока не перенастроит его.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания
причина
 reason string

причина

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
сообщение
 meta.message string

Message
type
 meta.type string

type

Создание отслеживания

Идентификатор операции:
CreateTracking

Создайте отслеживание.

Параметры

Имя Ключ Обязательно Тип Описание
слизняк
 slug string

Имя курьера
tracking_number
 tracking_number string

Номер отслеживания
title
 title string

title
smses
 smses array of

СМС
сообщения электронной почты
 emails array of

Адреса электронной почты
order_id
 order_id string

Идентификатор заказа
order_id_path
 order_id_path string

Путь к идентификатору заказа
product_name
 product_name string

product_name
product_price
 product_price string

product_price
language
 language string

Language
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

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
id
 data.tracking.id string

Идентификатор
создано_в
 data.tracking.created_at string

Дата и время создания
updated_at
 data.tracking.updated_at string

Обновленная дата и время
last_updated_at
 data.tracking.last_updated_at string

Дата и время последнего обновления
tracking_number
 data.tracking.tracking_number string

Номер отслеживания
слизняк
 data.tracking.slug string

Имя курьера
активный
 data.tracking.active boolean

Активное или неактивное отслеживание
андроид
 data.tracking.android array of

Андроид
custom_fields
 data.tracking.custom_fields string

Пользовательские поля
customer_name
 data.tracking.customer_name string

Имя клиента
delivery_time
 data.tracking.delivery_time integer

Дата и время доставки
destination_country_iso3
 data.tracking.destination_country_iso3 string

Код страны назначения в формате ISO 3
courier_destination_country_iso3
 data.tracking.courier_destination_country_iso3 string

Код страны-курьера в формате ISO 3
сообщения электронной почты
 data.tracking.emails array of

Адреса электронной почты
expected_delivery
 data.tracking.expected_delivery string

Ожидаемая дата и время доставки
ios
 data.tracking.ios array of

iOS
заметка
 data.tracking.note string

Примечания.
order_id
 data.tracking.order_id string

Идентификатор заказа
order_id_path
 data.tracking.order_id_path string

Путь к идентификатору заказа
origin_country_iso3
 data.tracking.origin_country_iso3 string

Исходный код страны в формате ISO 3
shipment_package_count
 data.tracking.shipment_package_count integer

Количество пакетов в доставке
shipment_pickup_date
 data.tracking.shipment_pickup_date string

Дата и время выбранных пакетов
shipment_delivery_date
 data.tracking.shipment_delivery_date string

Дата и время доставки пакетов
shipment_type
 data.tracking.shipment_type string

Тип отгрузки
shipment_weight
 data.tracking.shipment_weight integer

Вес отгрузки
shipment_weight_unit
 data.tracking.shipment_weight_unit string

Единица веса отгрузки
signed_by
 data.tracking.signed_by string

Подписан
smses
 data.tracking.smses array of

СМС
source
 data.tracking.source string

Исходный материал
tag
 data.tracking.tag string

Метки
вложенный тег
 data.tracking.subtag string

Вложенные теги
subtag_message
 data.tracking.subtag_message string

Сообщения вложенных тегов
title
 data.tracking.title string

title
tracked_count
 data.tracking.tracked_count integer

Количество отслеживаемых операций
last_mile_tracking_supported
 data.tracking.last_mile_tracking_supported boolean

Отслеживание последней мили поддерживается
language
 data.tracking.language string

Language
unique_token
 data.tracking.unique_token string

Уникальный маркер
Контрольные точки
 data.tracking.checkpoints array of

Контрольные точки
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

Удаление отслеживания

Идентификатор операции:
DeleteATracking

Удаление отслеживания.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
id
 data.tracking.id string

Идентификатор
tracking_number
 data.tracking.tracking_number string

Номер отслеживания
слизняк
 data.tracking.slug string

Имя курьера
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

Удаление уведомления

Идентификатор операции:
RemoveANotification

Удалите получателей уведомлений из номера отслеживания.

Параметры

Имя Ключ Обязательно Тип Описание
Курьер слизь
 slug True string

Курьер слизь
Номер отслеживания
 tracking_number True string

Введите номер отслеживания

Возвращаемое значение

Имя Путь Тип Описание
код
 meta.code integer

код
сообщения электронной почты
 data.notification.emails array of

Адреса электронной почты
smses
 data.notification.smses array of string

СМС