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

Easyship предоставляет мощную службу для добавления бесплатных вариантов доставки по всему миру на ваш веб-сайт и конец функциональным возможностям доставки в склад, ERP или платформу.

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

Услуга	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://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Трой Тейлор
Веб-сайт	https://www.easyship.com/
Политика конфиденциальности	https://www.easyship.com/legal/privacy
Категории	Управление бизнесом; Торговля

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

Соединитель поддерживает следующие типы проверки подлинности:


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

По умолчанию

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

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

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

Имя	Тип	Description	Обязательно
Маркер доступа API (в формате: Bearer APIAccessToken)	securestring	Маркер доступа API (в формате: Bearer APIAccessToken) для этого API	True

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

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

Действия

Запрос запроса на получение (V1)	При создании пикапа запрос на получение будет выполнен непосредственно курьеру, который вернет ссылочный номер. Ссылочный номер может использоваться при обращении в службу клиентов курьера. Необходимо выбрать слот для сбора данных; Предстоящие слоты сбора можно найти с помощью действия "Получить доступные слоты сбора".
Обновление отгрузки	Обновите сведения о доставке.
Обновление состояния хранилища	Обновите состояние склада отгрузки. Доступно только для поставок, выполненных на одном из интегрированных складов Easyship.
Перечисление всех поставок	Извлекает список всех поставок.
Покупка этикетки доставки (V1)	Приобретение и получение сведений о этикетке доставки.
Получение доступных слотов сбора (V1)	Доступные слоты для сбора будут вычисляться для определенного курьера, в местное время и в течение ближайших 7 дней. Затем можно запросить получение с помощью действия "Запрос на получение".
Получение категорий элементов	Извлекает список категорий поставок и slug для использования категории.
Получение контрольных точек	Извлекает сведения о контрольных точках доставки.
Получение отгрузки	Получение сведений о доставке.
Получение состояния отслеживания	Извлекает состояние отслеживания отгрузки.
Получение ставок и налогов	Получите список кавычки на доставку для потенциальной отгрузки.
Создание отгрузки	Создает и извлекает сведения о доставке.
Список всех полей	Извлекает список всех доступных ящиков курьера.
Удаление отгрузки (V1)	Удаление и получение подтверждения удаления отгрузки.

Запрос запроса на получение (V1)

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

При создании пикапа запрос на получение будет выполнен непосредственно курьеру, который вернет ссылочный номер. Ссылочный номер может использоваться при обращении в службу клиентов курьера. Необходимо выбрать слот для сбора данных; Предстоящие слоты сбора можно найти с помощью действия "Получить доступные слоты сбора".

Параметры

Имя	Ключ	Тип	Описание
Идентификатор курьера	courier_id	string	Идентификатор курьера.
Предпочтительная дата	preferred_date	string	Предпочтительная дата.
Предпочтительное максимальное время	preferred_max_time	string	Предпочтительное максимальное время.
Предпочтительное минимальное время	preferred_min_time	string	Предпочтительное минимальное время.
Идентификаторы отправки easyship	easyship_shipment_ids	array of string	Идентификаторы доставки Easyship.

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

Имя	Путь	Тип	Описание
Идентификатор курьера	courier_id	string	Идентификатор курьера.
Имя курьера	courier_name	string	Имя курьера.
Идентификаторы отправки easyship	easyship_shipment_ids	array of string	Идентификаторы доставки Easyship.
Easyship Pickup ID	pickup.easyship_pickup_id	string	Идентификатор пикапа Easyship.
Предпочтительное минимальное время	pickup.preferred_min_time	string	Предпочтительное минимальное время.
Предпочтительное максимальное время	pickup.preferred_max_time	string	Предпочтительное максимальное время.
Справочный номер пикапа	pickup.pickup_reference_number	string	Справочный номер пикапа.
Плата за сбор	pickup.pickup_fee	string	Плата за сбор.
Имя поставщика	pickup.provider_name	string	Имя поставщика.
Телефон службы клиентов поставщика	pickup.provider_customer_service_phone	string	Номер телефона службы клиентов поставщика.
Количество поставок	pickup.shipments_count	string	Количество поставок.
Общий фактический вес	pickup.total_actual_weight	string	Общий фактический вес.
Состояние выбора	pickup.pickup_state	string	Состояние сбора.
Address	pickup.address.line_1	string	Адрес.
Строка адреса 2	pickup.address.line_2	string	Адресная строка 2.
Адресная строка 3	pickup.address.line_3	string	Адресная строка 3.
Почтовый индекс	pickup.address.postal_code	string	Почтовый индекс.
Город	pickup.address.city	string	Город.
Государство	pickup.address.state	string	Государство.
Страна	pickup.address.country	string	Страна.
Контактный адрес электронной почты	pickup.address.contact_email	string	Адрес электронной почты контакта.
Контактный телефон	pickup.address.contact_phone	string	Номер телефона контакта.
Название компании	pickup.address.company_name	string	Название компании.
Имя контактного лица	pickup.address.contact_name	string	Имя контакта.

Обновление отгрузки

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

Обновите сведения о доставке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id	True	string	Идентификатор доставки Easyship.
Код страны назначения	destination_country_alpha2		string	Код страны назначения.
Целевой город	destination_city		string	Целевой город.
Имя назначения	destination_name		string	Имя назначения.
Адрес назначения	destination_address_line_1		string	Адрес назначения.
Номер телефона назначения	destination_phone_number		string	Номер целевого телефона.
Description	description		string	Описание.
Фактический вес	actual_weight		float	Фактический вес.
Высота	height		integer	Высота.
Ширина	width		integer	Ширина.
Length	length		integer	Длина.
Категория	category		string	Категория.
Объявленная валюта	declared_currency		string	Объявленная валюта.
Объявленная таможенные значения	declared_customs_value		integer	Объявленная таможенная стоимость.
Артикул (SKU)	sku		string	Номер SKU.
Имя платформы	platform_name		string	Имя платформы.
Номер заказа платформы	platform_order_number		string	Номер заказа платформы.
Налоги, оплаченные	taxes_duties_paid_by		string	Налоги и обязанности, оплаченные.
Застраховано	is_insured		boolean	Является ли застраховано.
Выбранный идентификатор курьера	selected_courier_id		string	Выбранный идентификатор курьера.
Почтовый индекс назначения	destination_postal_code		integer	Почтовый индекс назначения.
Конечное состояние	destination_state		string	Конечное состояние.
Адрес назначения 2	destination_address_line_2		string	Адрес назначения 2.
Адрес целевой электронной почты	destination_email_address		string	Адрес целевой электронной почты.

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

Имя	Путь	Тип	Описание
Создано в	shipment.created_at	string	Создано в.
Обновлено в	shipment.updated_at	string	При обновлении по адресу.
Идентификатор отгрузки Easyship	shipment.easyship_shipment_id	string	Идентификатор доставки Easyship.
Имя назначения	shipment.destination_name	string	Имя назначения.
Адрес назначения	shipment.destination_address_line_1	string	Адрес назначения.
Адрес назначения 2	shipment.destination_address_line_2	string	Адрес назначения 2.
Целевой город	shipment.destination_city	string	Целевой город.
Конечное состояние	shipment.destination_state	string	Конечное состояние.
Почтовый индекс назначения	shipment.destination_postal_code	string	Почтовый индекс назначения.
Номер телефона назначения	shipment.destination_phone_number	string	Номер целевого телефона.
Адрес целевой электронной почты	shipment.destination_email_address	string	Адрес целевой электронной почты.
Имя платформы	shipment.platform_name	string	Имя платформы.
Номер заказа платформы	shipment.platform_order_number	string	Номер заказа платформы.
Общая стоимость таможенных правил	shipment.total_customs_value	float	Общая таможенная стоимость.
Общий фактический вес	shipment.total_actual_weight	float	Общий фактический вес.
Общий размерный вес	shipment.total_dimensional_weight	float	Общий размерный вес.
Общий объем тома	shipment.total_volumetric_weight	float	Общий объемный объем.
Застраховано	shipment.is_insured	boolean	Является ли застраховано.
Валюта	shipment.currency	string	Валюта.
Имя	shipment.origin_country.name	string	Имя.
Код страны	shipment.origin_country.alpha2	string	Код страны.
Имя	shipment.destination_country.name	string	Имя.
Код страны	shipment.destination_country.alpha2	string	Код страны.
Товары	shipment.items	array of object
Идентификатор	shipment.items.id	string	Уникальный идентификатор.
Description	shipment.items.description	string	Описание.
Артикул (SKU)	shipment.items.sku	string	Номер SKU.
Ширина	shipment.items.width	integer	Ширина.
Length	shipment.items.length	integer	Длина.
Высота	shipment.items.height	integer	Высота.
Фактический вес	shipment.items.actual_weight	float	Фактический вес.
Размерный вес	shipment.items.dimensional_weight	float	Размерный вес.
Объемный вес	shipment.items.volumetric_weight	float	Вес колуметрики.
Объявленная таможенные значения	shipment.items.declared_customs_value	integer	Объявленная таможенная стоимость.
Объявленная валюта	shipment.items.declared_currency	string	Объявленная валюта.
Стоимость происхождения таможенных правил	shipment.items.origin_customs_value	float	Исходная таможенные значения.
Исходная валюта	shipment.items.origin_currency	string	Исходная валюта.
Категория	shipment.items.category	string	Категория.
Имя	shipment.box.name	string	Имя.
Length	shipment.box.length	integer	Длина.
Ширина	shipment.box.width	integer	Ширина.
Высота	shipment.box.height	integer	Высота.
Идентификатор	shipment.selected_courier.id	string	Уникальный идентификатор.
Имя	shipment.selected_courier.name	string	Имя.
Минимальное время доставки	shipment.selected_courier.min_delivery_time	integer	Минимальное время доставки.
Максимальное время доставки	shipment.selected_courier.max_delivery_time	integer	Максимальное время доставки.
Плата за доставку	shipment.selected_courier.shipment_charge	float	Плата за доставку.
Дополнительная плата за топливо	shipment.selected_courier.fuel_surcharge	float	Плата за топливо.
Дополнительная плата за удаленный район	shipment.selected_courier.remote_area_surcharge	integer	Плата за удаленный район.
Сумма платы за доставку	shipment.selected_courier.shipment_charge_total	float	Сумма платы за доставку.
Плата за обработку склада	shipment.selected_courier.warehouse_handling_fee	integer	Плата за обработку склада.
Страховая плата	shipment.selected_courier.insurance_fee	integer	Страховая плата.
Плата за импорт налога	shipment.selected_courier.import_tax_charge	integer	Налог на импорт.
Плата за импортную плату	shipment.selected_courier.import_duty_charge	integer	Плата за импорт.
Плата за обработку DDP	shipment.selected_courier.ddp_handling_fee	integer	Плата за обработку DDP.
Общая плата	shipment.selected_courier.total_charge	float	Общая плата.
Выше порогового значения	shipment.selected_courier.is_above_threshold	boolean	Указывает, превышает ли пороговое значение.
Эффективные инкотермс	shipment.selected_courier.effective_incoterms	string	Эффективные инкотермы.
Предполагаемый налог на импорт	shipment.selected_courier.estimated_import_tax	integer	Оценка налога на импорт.
Предполагаемый импортный сбор	shipment.selected_courier.estimated_import_duty	integer	Предполагаемый импортный сбор.
Курьер делает пикап	shipment.selected_courier.courier_does_pickup	boolean	Будет ли курьер забрать.
URL-адрес dropoff для курьера	shipment.selected_courier.courier_dropoff_url	string	URL-адрес раскрывающегося url-адреса курьера.
Примечания курьера	shipment.selected_courier.courier_remarks	string	Примечания курьера.
Получатель оплаты	shipment.selected_courier.payment_recipient	string	Получатель оплаты.
Ставки	shipment.rates	array of object
Идентификатор курьера	shipment.rates.courier_id	string	Идентификатор курьера.
Имя курьера	shipment.rates.courier_name	string	Имя курьера.
Минимальное время доставки	shipment.rates.min_delivery_time	integer	Минимальное время доставки.
Максимальное время доставки	shipment.rates.max_delivery_time	integer	Максимальное время доставки.
Значение для ранжирования денег	shipment.rates.value_for_money_rank	integer	Значение для денежного ранга.
Ранг времени доставки	shipment.rates.delivery_time_rank	integer	Ранг времени доставки.
Плата за доставку	shipment.rates.shipment_charge	float	Плата за доставку.
Дополнительная плата за топливо	shipment.rates.fuel_surcharge	float	Плата за топливо.
Дополнительная плата за удаленный район	shipment.rates.remote_area_surcharge	integer	Плата за удаленный район.
Сумма платы за доставку	shipment.rates.shipment_charge_total	float	Сумма платы за доставку.
Плата за обработку склада	shipment.rates.warehouse_handling_fee	integer	Плата за обработку склада.
Страховая плата	shipment.rates.insurance_fee	integer	Страховая плата.
Плата за обработку DDP	shipment.rates.ddp_handling_fee	integer	Плата за обработку DDP.
Плата за импорт налога	shipment.rates.import_tax_charge	integer	Изменение налога на импорт.
Плата за импортную плату	shipment.rates.import_duty_charge	integer	Плата за импорт.
Общая плата	shipment.rates.total_charge	float	Общая плата.
Выше порогового значения	shipment.rates.is_above_threshold	boolean	Указывает, превышает ли пороговое значение.
Эффективные инкотермс	shipment.rates.effective_incoterms	string	Эффективные инкотермы.
Предполагаемый налог на импорт	shipment.rates.estimated_import_tax	integer	Предполагаемый налог на импорт.
Предполагаемый импортный сбор	shipment.rates.estimated_import_duty	integer	Предполагаемый импортный сбор.
Курьер делает пикап	shipment.rates.courier_does_pickup	boolean	Будет ли курьер забрать.
URL-адрес dropoff для курьера	shipment.rates.courier_dropoff_url	string	URL-адрес раскрывающегося url-адреса курьера.
Рейтинг отслеживания	shipment.rates.tracking_rating	integer	Рейтинг отслеживания.
Рейтинг Easyship	shipment.rates.easyship_rating	float	Рейтинг Easyship.
Примечания курьера	shipment.rates.courier_remarks	string	Примечания курьера.
Получатель оплаты	shipment.rates.payment_recipient	string	Получатель оплаты.

Обновление состояния хранилища

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

Обновите состояние склада отгрузки. Доступно только для поставок, выполненных на одном из интегрированных складов Easyship.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Состояние хранилища	warehouse_state	string	Состояние хранилища.
Message	message	string	Сообщение.
Серийный номер	serial_number	string	Серийный номер.

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

Имя	Путь	Тип	Описание
Message	message	array of object
Идентификатор отгрузки Easyship	message.easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Состояние хранилища обновлено	message.warehouse_state_updated	string	Обновленное состояние хранилища.

Перечисление всех поставок

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

Извлекает список всех поставок.

Параметры

Имя	Ключ	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Номер заказа платформы	platform_order_number	string	Номер заказа платформы.
Страница	page	integer	Страница.
На страницу	per_page	integer	Число на страницу.
Создано из	created_at_from	string	Созданный из.
Создано по адресу	created_at_to	string	Созданное по адресу.
Подтверждено из	confirmed_at_from	string	Подтверждено от.
Подтверждено по адресу	confirm_at_to	string	Подтверждено.
Создание метки из	label_generated_at_from	string	Метка создается из.
Метка, созданная по адресу	label_generated_at_to	string	Метка, созданная по адресу.
Состояние отгрузки	shipment_state	string	Состояние отгрузки.
Состояние выбора	pickup_state	string	Состояние сбора.
Состояние доставки	delivery_state	string	Состояние доставки.
Состояние метки	label_state	string	Состояние метки.
Состояние хранилища	warehouse_state	string	Состояние хранилища.

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

Имя	Путь	Тип	Описание
Поставки	shipments	array of object
Идентификатор отгрузки Easyship	shipments.easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Создано в	shipments.created_at	string	Создано в.
Обновлено в	shipments.updated_at	string	Обновлено.
Платная метка	shipments.label_paid_at	string	Метка заплатила.
Метка, созданная в	shipments.label_generated_at	string	Создано в.
Заказ создан в	shipments.order_created_at	string	Заказ, созданный по адресу.
Address	shipments.origin_address.line_1	string	Адрес.
Строка адреса 2	shipments.origin_address.line_2	string	Адресная строка 2.
Государство	shipments.origin_address.state	string	Государство.
Город	shipments.origin_address.city	string	Город.
Почтовый индекс	shipments.origin_address.postal_code	string	Почтовый индекс.
Код страны	shipments.origin_address.country_alpha2	string	Код страны.
Имя контактного лица	shipments.origin_address.contact_name	string	Имя контакта.
Название компании	shipments.origin_address.company_name	string	Название компании.
Контактный телефон	shipments.origin_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipments.origin_address.contact_email	string	Адрес электронной почты контакта.
Address	shipments.sender_address.line_1	string	Адрес.
Строка адреса 2	shipments.sender_address.line_2	string	Адресная строка 2.
Государство	shipments.sender_address.state	string	Государство.
Город	shipments.sender_address.city	string	Город.
Почтовый индекс	shipments.sender_address.postal_code	string	Почтовый индекс.
Код страны	shipments.sender_address.country_alpha2	string	Код страны.
Имя контактного лица	shipments.sender_address.contact_name	string	Имя контакта.
Название компании	shipments.sender_address.company_name	string	Название компании.
Контактный телефон	shipments.sender_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipments.sender_address.contact_email	string	Адрес электронной почты контакта.
Address	shipments.return_address.line_1	string	Адрес.
Строка адреса 2	shipments.return_address.line_2	string	Адресная строка 2.
Государство	shipments.return_address.state	string	Государство.
Город	shipments.return_address.city	string	Город.
Почтовый индекс	shipments.return_address.postal_code	string	Почтовый индекс.
Код страны	shipments.return_address.country_alpha2	string	Код страны.
Имя контактного лица	shipments.return_address.contact_name	string	Имя контакта.
Название компании	shipments.return_address.company_name	string	Название компании.
Контактный телефон	shipments.return_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipments.return_address.contact_email	string	Адрес электронной почты контакта.
Address	shipments.destination_address.line_1	string	Адрес.
Строка адреса 2	shipments.destination_address.line_2	string	Адресная строка 2.
Государство	shipments.destination_address.state	string	Государство.
Город	shipments.destination_address.city	string	Город.
Почтовый индекс	shipments.destination_address.postal_code	string	Почтовый индекс.
Код страны	shipments.destination_address.country_alpha2	string	Код страны.
Имя контактного лица	shipments.destination_address.contact_name	string	Имя контакта.
Название компании	shipments.destination_address.company_name	string	Название компании.
Контактный телефон	shipments.destination_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipments.destination_address.contact_email	string	Адрес электронной почты контакта.
Имя платформы	shipments.order_data.platform_name	string	Имя платформы.
Номер заказа платформы	shipments.order_data.platform_order_number	string	Номер заказа платформы.
Список тегов заказа	shipments.order_data.order_tag_list	array of string	Список тегов заказа
Заметки о продавце	shipments.order_data.seller_notes	string	Заметки продавца.
Заметки покупателя	shipments.order_data.buyer_notes	string	Покупатель отмечает.
Установка в качестве жилого	shipments.set_as_residential	boolean	Задано ли значение как жилое.
Налоговый идентификатор получателя	shipments.consignee_tax_id	string	Идентификатор налога получателя.
Справочник по EEI	shipments.eei_reference	string	Справочник по EEI.
Incoterms	shipments.incoterms	string	Incoterms.
Застраховано	shipments.insurance.is_insured	boolean	Является ли застраховано.
Страховая сумма	shipments.insurance.insured_amount	integer	Страховая сумма.
Застрахованная валюта	shipments.insurance.insured_currency	string	Застрахованная валюта.
Участков	shipments.parcels	array of object
Общий фактический вес	shipments.parcels.total_actual_weight	float	Общий фактический вес.
Общая стоимость таможенных правил	shipments.parcels.total_customs_value	float	Общая таможенная стоимость.
Общий размерный вес	shipments.parcels.total_dimensional_weight	float	Общий размерный вес.
Общий объем тома	shipments.parcels.total_volumetric_weight	float	Общий объемный объем.
Идентификатор	shipments.parcels.box.id	string	Уникальный идентификатор.
Имя курьерского зонтика	shipments.parcels.box.courier_umbrella_name	string	Имя курьерского зонтика.
Имя	shipments.parcels.box.name	string	Имя.
Slug	shipments.parcels.box.slug	string	Слизь.
Внешняя длина	shipments.parcels.box.outer_length	float	Внешняя длина.
Внешняя ширина	shipments.parcels.box.outer_width	float	Внешняя ширина.
Внешняя высота	shipments.parcels.box.outer_height	float	Внешняя высота.
Weight	shipments.parcels.box.weight	integer	Вес.
Товары	shipments.parcels.items	array of object
Description	shipments.parcels.items.description	string	Описание.
Категория	shipments.parcels.items.category	string	Категория.
Артикул (SKU)	shipments.parcels.items.sku	string	Номер SKU.
Количество	shipments.parcels.items.quantity	integer	Количество.
Фактический вес	shipments.parcels.items.actual_weight	integer	Фактический вес.
Размерный вес	shipments.parcels.items.dimensional_weight	integer	Размерный вес.
Объемный вес	shipments.parcels.items.volumetric_weight	integer	Объемный вес.
Исходная валюта	shipments.parcels.items.origin_currency	string	Исходная валюта.
Стоимость происхождения таможенных правил	shipments.parcels.items.origin_customs_value	integer	Исходная таможенные значения.
Объявленная валюта	shipments.parcels.items.declared_currency	string	Объявленная валюта.
Объявленная таможенные значения	shipments.parcels.items.declared_customs_value	integer	Объявленная таможенная стоимость.
Length	shipments.parcels.items.dimensions.length	integer	Длина.
Ширина	shipments.parcels.items.dimensions.width	integer	Ширина.
Высота	shipments.parcels.items.dimensions.height	integer	Высота.
Общая стоимость таможенных правил	shipments.total_customs_value	float	Общая таможенная стоимость.
Общий фактический вес	shipments.total_actual_weight	float	Общий фактический вес.
Общий размерный вес	shipments.total_dimensional_weight	float	Общий размерный вес.
Общий объем тома	shipments.total_volumetric_weight	float	Общий объемный объем.
Состояние отгрузки	shipments.shipment_state	string	Состояние отгрузки.
Состояние выбора	shipments.pickup_state	string	Состояние сбора.
Состояние доставки	shipments.delivery_state	string	Состояние доставки.
Состояние метки	shipments.label_state	string	Состояние метки.
Состояние хранилища	shipments.warehouse_state	string	Состояние хранилища.
Отслеживание	shipments.trackings	array of object
Номер отслеживания	shipments.trackings.tracking_number	string	Номер отслеживания.
Локальный номер отслеживания	shipments.trackings.local_tracking_number	string	Номер локального отслеживания.
Альтернативный номер отслеживания	shipments.trackings.alternate_tracking_number	string	Альтернативный номер отслеживания.
Номер ноги	shipments.trackings.leg_number	integer	Номер ноги.
Обработчик	shipments.trackings.handler	string	Обработчик.
Отслеживание состояния	shipments.trackings.tracking_state	string	Состояние отслеживания.
URL-адрес страницы отслеживания	shipments.tracking_page_url	string	URL-адрес страницы отслеживания.
Документы о доставке	shipments.shipping_documents	array of	Документы о доставке.
Валюта	shipments.currency	string	Валюта.
Идентификатор	shipments.selected_courier.id	string	Уникальный идентификатор.
Ставки	shipments.rates	array of object
Идентификатор курьера	shipments.rates.courier_id	string	Уникальный идентификатор курьера.
Имя курьера	shipments.rates.courier_name	string	Имя курьера.
Минимальное время доставки	shipments.rates.min_delivery_time	integer	Минимальное время доставки.
Максимальное время доставки	shipments.rates.max_delivery_time	integer	Максимальное время доставки.
Значение для ранжирования денег	shipments.rates.value_for_money_rank	integer	Значение для денежного ранга.
Ранг времени доставки	shipments.rates.delivery_time_rank	integer	Ранг времени доставки.
Плата за доставку	shipments.rates.shipment_charge	float	Плата за доставку.
Дополнительная плата за топливо	shipments.rates.fuel_surcharge	float	Плата за топливо.
Дополнительная плата за удаленный район	shipments.rates.remote_area_surcharge	integer	Плата за удаленный район.
Превышенная дополнительная плата	shipments.rates.oversized_surcharge	integer	Сверхоценная плата.
Дополнительная плата за дополнительные услуги	shipments.rates.additional_services_surcharge	integer	Дополнительная плата за услуги.
Полная плата за жилье	shipments.rates.residential_full_fee	integer	Жилая полная плата.
Плата за жилье с скидкой	shipments.rates.residential_discounted_fee	integer	Плата за жилье с скидкой.
Сумма платы за доставку	shipments.rates.shipment_charge_total	float	Сумма платы за доставку.
Плата за обработку склада	shipments.rates.warehouse_handling_fee	integer	Плата за обработку склада.
Страховая плата	shipments.rates.insurance_fee	integer	Страховая плата.
Налог с продаж	shipments.rates.sales_tax	integer	Налог на продажу.
Налог на продажу в провинции	shipments.rates.provincial_sales_tax	integer	Налог на продажу в провинции.
Плата за обработку DDP	shipments.rates.ddp_handling_fee	integer	Плата за обработку DDP.
Плата за импорт налога	shipments.rates.import_tax_charge	integer	Налог на импорт.
Плата за импортную плату	shipments.rates.import_duty_charge	integer	Плата за импорт.
Общая плата	shipments.rates.total_charge	float	Общая плата.
Выше порогового значения	shipments.rates.is_above_threshold	boolean	Указывает, превышает ли пороговое значение.
Incoterms	shipments.rates.incoterms	string	Incoterms.
Предполагаемый налог на импорт	shipments.rates.estimated_import_tax	integer	Предполагаемый налог на импорт.
Предполагаемый импортный сбор	shipments.rates.estimated_import_duty	integer	Предполагаемый импортный сбор.
Доступные параметры передачи	shipments.rates.available_handover_options	string	Доступные параметры передачи.
Рейтинг отслеживания	shipments.rates.tracking_rating	integer	Рейтинг отслеживания.
Рейтинг Easyship	shipments.rates.easyship_rating	integer	Рейтинг Easyship.
Примечания курьера	shipments.rates.courier_remarks	string	Примечания курьера.
Получатель оплаты	shipments.rates.payment_recipient	string	Получатель оплаты.
Code	shipments.rates.discount.code	string	Код.
Сумма	shipments.rates.discount.amount	integer	Сумма.
Истекает в	shipments.rates.discount.expires_at	string	Срок действия истекает.
Процент	shipments.rates.discount.percentage	string	Процент.
Эффективные инкотермс	shipments.rates.effective_incoterms	string	Эффективные инкотермы.

Покупка этикетки доставки (V1)

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

Приобретение и получение сведений о этикетке доставки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id		string	Уникальный идентификатор отгрузки Easyship.
Идентификатор курьера	courier_id		string	Уникальный идентификатор курьера.

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

Имя	Путь	Тип	Описание
Message	message	string	Сообщение.
Errors	errors	array of	Ошибки.
Общая стоимость	total_cost	integer	Общая стоимость.
Доступный баланс	available_balance	integer	Доступный баланс.
Наклейки	labels	array of object
Идентификатор отгрузки Easyship	labels.easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Состояние метки	labels.label_state	string	Состояние метки.
URL-адрес метки	labels.label_url	string	URL-адрес метки.
Состояние	labels.status	string	Состояние.
Номер отслеживания	labels.tracking_number	string	Номер отслеживания.
URL-адрес страницы отслеживания	labels.tracking_page_url	string	URL-адрес страницы отслеживания.

Получение доступных слотов сбора (V1)

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

Доступные слоты для сбора будут вычисляться для определенного курьера, в местное время и в течение ближайших 7 дней. Затем можно запросить получение с помощью действия "Запрос на получение".

Параметры

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

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

Имя	Путь	Тип	Описание
Идентификатор курьера	courier_id	string	Идентификатор курьера.
Имя курьера	courier_name	string	Имя курьера.
Message	message	string	Сообщение.
Имя поставщика	pickup.provider_name	string	Имя поставщика.
Телефон службы клиентов поставщика	pickup.provider_customer_service_phone	string	Номер телефона службы клиентов поставщика.

Получение категорий элементов

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

Извлекает список категорий поставок и slug для использования категории.

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

Имя	Путь	Тип	Описание
Категории	categories	array of object
Имя	categories.name	string	Имя.
Slug	categories.slug	string	Слизь.

Получение контрольных точек

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

Извлекает сведения о контрольных точках доставки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id	True	string	Уникальный идентификатор отгрузки Easyship.
Номер заказа платформы	platform_order_number		string	Номер заказа платформы.
Страница	page		integer	Страница.
На страницу	per_page		integer	Число на страницу.

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

Имя	Путь	Тип	Описание
Всего страницы	total_page	integer	Общая страница.
Текущая страница	current_page	integer	Текущая страница.
Поставки	shipments	array of object
Идентификатор отгрузки Easyship	shipments.easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Номер заказа платформы	shipments.platform_order_number	string	Номер заказа платформы.
Происхождение	shipments.origin	string	Источник.
Место назначения	shipments.destination	string	Назначение.
Состояние	shipments.status	string	Состояние.
Номер отслеживания	shipments.tracking_number	string	Номер отслеживания.
URL-адрес страницы отслеживания	shipments.tracking_page_url	string	URL-адрес страницы отслеживания.
Checkpoints	shipments.checkpoints	array of object
Номер заказа	shipments.checkpoints.order_number	integer	Номер заказа.
Обработчик	shipments.checkpoints.handler	string	Обработчик.
Message	shipments.checkpoints.message	string	Сообщение.
Местоположение	shipments.checkpoints.location	string	Расположение.
Город	shipments.checkpoints.city	string	Город.
Страна	shipments.checkpoints.country_name	string	Страна.
Код страны	shipments.checkpoints.country_iso3	string	Код страны.
Координаты	shipments.checkpoints.coordinates	array of	Координаты.
Государство	shipments.checkpoints.state	string	Государство.
Почтовый индекс	shipments.checkpoints.postal_code	string	Почтовый индекс.
Время контрольной точки	shipments.checkpoints.checkpoint_time	string	Время контрольной точки.
Основное состояние	shipments.checkpoints.primary_status	string	Основное состояние.

Получение отгрузки

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

Получение сведений о доставке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id	True	string	Идентификатор доставки Easyship.
Формат	format		string	Формат.
Этикетка	label		string	Метка.
Коммерческий счет	commercial_invoice		string	Коммерческий счет.
Упаковка скольжения	packing_slip		string	Скольжение упаковки.

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

Имя	Путь	Тип	Описание
Создано в	created_at	string	При создании.
Обновлено в	updated_at	string	При обновлении по адресу.
Идентификатор отгрузки Easyship	easyship_shipment_id	string	Неуправляемый груз.
Имя назначения	destination_name	string	Имя назначения.
Адрес назначения	destination_address_line_1	string	Адрес назначения.
Адрес назначения 2	destination_address_line_2	string	Адрес назначения 2.
Целевой город	destination_city	string	Целевой город.
Конечное состояние	destination_state	string	Конечное состояние.
Почтовый индекс назначения	destination_postal_code	string	Почтовый индекс назначения.
Номер телефона назначения	destination_phone_number	string	Номер целевого телефона.
Адрес целевой электронной почты	destination_email_address	string	Адрес целевой электронной почты.
Заметки о заказе	order_notes	string	Заметки о заказе.
Заказ создан в	order_created_at	string	Заказ, созданный по адресу.
Имя платформы	platform_name	string	Имя платформы.
Номер заказа платформы	platform_order_number	string	Номер заказа платформы.
Общая стоимость таможенных правил	total_customs_value	float	Общая таможенная стоимость.
Общий фактический вес	total_actual_weight	float	Общий фактический вес.
Общий размерный вес	total_dimensional_weight	float	Общий размерный вес.
Общий объем тома	total_volumetric_weight	float	Общий объемный объем.
Застраховано	is_insured	boolean	Является ли застраховано.
Валюта	currency	string	Валюта.
Состояние хранилища	warehouse_state	string	Состояние хранилища.
Имя	origin_country.name	string	Имя.
Код страны	origin_country.alpha2	string	Код страны.
Имя	destination_country.name	string	Имя.
Код страны	destination_country.alpha2	string	Код страны.
Товары	items	array of object
Идентификатор	items.id	string	Уникальный идентификатор.
Description	items.title	string	Описание.
Артикул (SKU)	items.sku	string	Номер SKU.
Ширина	items.width	integer	Ширина.
Length	items.length	integer	Длина.
Высота	items.height	integer	Высота.
Фактический вес	items.actual_weight	float	Фактический вес.
Размерный вес	items.dimensional_weight	float	Размерный вес.
Объемный вес	items.volumetric_weight	float	Объемный вес.
Объявленная таможенные значения	items.declared_customs_value	integer	Объявленная таможенная стоимость.
Объявленная валюта	items.declared_currency	string	Объявленная валюта.
Стоимость происхождения таможенных правил	items.origin_customs_value	float	Исходная таможенные значения.
Исходная валюта	items.origin_currency	string	Исходная валюта.
Категория	items.category	string	Категория.
Имя	box.name	string	Имя.
Length	box.length	integer	Длина.
Ширина	box.width	integer	Ширина.
Высота	box.height	integer	Высота.
Идентификатор	selected_courier.id	string	Уникальный идентификатор.
Имя	selected_courier.name	string	Имя.
Минимальное время доставки	selected_courier.min_delivery_time	integer	Минимальное время доставки.
Максимальное время доставки	selected_courier.max_delivery_time	integer	Максимальное время доставки.
Плата за доставку	selected_courier.shipment_charge	float	Плата за доставку.
Дополнительная плата за топливо	selected_courier.fuel_surcharge	float	Плата за топливо.
Дополнительная плата за удаленный район	selected_courier.remote_area_surcharge	integer	Плата за удаленный район.
Сумма платы за доставку	selected_courier.shipment_charge_total	float	Сумма платы за доставку.
Плата за обработку склада	selected_courier.warehouse_handling_fee	integer	Плата за обработку склада.
Страховая плата	selected_courier.insurance_fee	integer	Страховая плата.
Плата за импорт налога	selected_courier.import_tax_charge	integer	Налог на импорт.
Плата за импортную плату	selected_courier.import_duty_charge	integer	Плата за импорт.
Плата за обработку DDP	selected_courier.ddp_handling_fee	integer	Плата за обработку DDP.
Общая плата	selected_courier.total_charge	float	Общая плата.
Выше порогового значения	selected_courier.is_above_threshold	boolean	Указывает, превышает ли пороговое значение.
Эффективные инкотермс	selected_courier.effective_incoterms	string	Эффективные инкотермы.
Предполагаемый налог на импорт	selected_courier.estimated_import_tax	integer	Предполагаемый импортированный налог.
Предполагаемый импортный сбор	selected_courier.estimated_import_duty	integer	Предполагаемый импортный сбор.
Курьер делает пикап	selected_courier.courier_does_pickup	boolean	Будет ли курьер забрать.
URL-адрес dropoff для курьера	selected_courier.courier_dropoff_url	string	URL-адрес раскрывающегося url-адреса курьера.
Примечания курьера	selected_courier.courier_remarks	string	Примечания курьера.
Получатель оплаты	selected_courier.payment_recipient	string	Получатель оплаты.
Обязательно	shipping_documents.label.required	boolean	Требуется ли это.
Размер страницы	shipping_documents.label.page_size	string	Размер страницы.
Формат	shipping_documents.label.format	string	Формат.
Строки в кодировке Base64	shipping_documents.label.base64_encoded_strings	array of string	Строки в кодировке Base64.
URL	shipping_documents.label.url	string	URL-адрес.
Message	shipping_documents.label.message	string	Сообщение.
Обязательно	shipping_documents.commercial_invoice.required	boolean	Требуется ли это.
Размер страницы	shipping_documents.commercial_invoice.page_size	string	Размер страницы.
Формат	shipping_documents.commercial_invoice.format	string	Формат.
Строки в кодировке Base64	shipping_documents.commercial_invoice.base64_encoded_strings	array of	Строки в кодировке Base64.
URL	shipping_documents.commercial_invoice.url	string	URL-адрес.
Обязательно	shipping_documents.packing_slip.required	boolean	Требуется ли это.
Размер страницы	shipping_documents.packing_slip.page_size	string	Размер страницы.
Формат	shipping_documents.packing_slip.format	string	Формат.
Строки в кодировке Base64	shipping_documents.packing_slip.base64_encoded_strings	array of string	Строки в кодировке Base64.
URL	shipping_documents.packing_slip.url	string	URL-адрес.
Обязательно	shipping_documents.battery_form.required	boolean	Требуется ли это.
Размер страницы	shipping_documents.battery_form.page_size	string	Размер страницы.
Формат	shipping_documents.battery_form.format	string	Формат.
Строки в кодировке Base64	shipping_documents.battery_form.base64_encoded_strings	array of	Строки в кодировке Base64.
URL	shipping_documents.battery_form.url	string	URL-адрес.
Обязательно	shipping_documents.battery_caution_label.required	boolean	Требуется ли это.
Размер страницы	shipping_documents.battery_caution_label.page_size	string	Размер страницы.
Формат	shipping_documents.battery_caution_label.format	string	Формат.
Строки в кодировке Base64	shipping_documents.battery_caution_label.base64_encoded_strings	array of	Строки в кодировке Base64.
URL	shipping_documents.battery_caution_label.url	string	URL-адрес.

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

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

Извлекает состояние отслеживания отгрузки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификаторы отправки easyship	easyship_shipment_id	True	string	Идентификаторы доставки Easyship.
Номер заказа платформы	platform_order_number		string	Номер заказа платформы.
Страница	page		integer	Страница.
На страницу	per_page		integer	Число на страницу.

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

Имя	Путь	Тип	Описание
Всего страницы	total_page	integer	Общая страница.
Текущая страница	current_page	integer	Текущая страница.
Поставки	shipments	array of object
Идентификатор отгрузки Easyship	shipments.easyship_shipment_id	string	Уникальный идентификатор отгрузки Easyship.
Номер заказа платформы	shipments.platform_order_number	string	Номер заказа платформы.
Происхождение	shipments.origin	string	Источник.
Место назначения	shipments.destination	string	Назначение.
Состояние	shipments.status	string	Состояние.
Номер отслеживания	shipments.tracking_number	string	Номер отслеживания.
URL-адрес страницы отслеживания	shipments.tracking_page_url	string	URL-адрес страницы отслеживания.

Получение ставок и налогов

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

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

Параметры

Имя	Ключ	Тип	Описание
Address	line_1	string	Адрес.
Строка адреса 2	line_2	string	Адресная строка 2.
Государство	state	string	Государство.
Город	city	string	Город.
Почтовый индекс	postal_code	string	Почтовый индекс.
Код страны	country_alpha2	string	Код страны.
Address	line_1	string	Адрес.
Строка адреса 2	line_2	string	Адресная строка 2.
Государство	state	string	Государство.
Город	city	string	Город.
Почтовый индекс	postal_code	string	Почтовый индекс.
Код страны	country_alpha2	string	Код страны.
Incoterms	incoterms	string	Incoterms.
Застраховано	is_insured	boolean	Является ли застраховано.
Страховая сумма	insured_amount	integer	Страховая сумма.
Застрахованная валюта	insured_currency	string	Застрахованная валюта.
Применение правил доставки	apply_shipping_rules	boolean	Применяются ли правила доставки.
Weight	weight	string	Вес.
Измерения	dimensions	string	Измерения.
Выходная валюта	output_currency	string	Выходная валюта.
Общий фактический вес	total_actual_weight	float	Общий фактический вес.
Slug	slug	string	Ссылочный слизь.
Length	length	integer	Длина.
Ширина	width	integer	Ширина.
Высота	height	integer	Высота.
Description	description	string	Описание.
Категория	category	string	Категория.
Артикул (SKU)	sku	string	Номер SKU.
Количество	quantity	integer	Количество.
Length	length	string	Длина.
Ширина	width	string	Ширина.
Высота	height	string	Высота.
Фактический вес	actual_weight	integer	Фактический вес.
Объявленная валюта	declared_currency	string	Объявленная валюта.
Объявленная таможенные значения	declared_customs_value	integer	Объявленная таможенная стоимость.

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

Имя	Путь	Тип	Описание
Ставки	rates	array of object
Идентификатор курьера	rates.courier_id	string	Уникальный идентификатор курьера.
Имя курьера	rates.courier_name	string	Имя курьера.
Минимальное время доставки	rates.min_delivery_time	integer	Минимальное время доставки.
Максимальное время доставки	rates.max_delivery_time	integer	Максимальное время доставки.
Значение для ранжирования денег	rates.value_for_money_rank	integer	Значение для денежного ранга.
Ранг времени доставки	rates.delivery_time_rank	integer	Ранг времени доставки.
Плата за доставку	rates.shipment_charge	float	Плата за доставку.
Дополнительная плата за топливо	rates.fuel_surcharge	float	Плата за топливо.
Дополнительная плата за удаленный район	rates.remote_area_surcharge	integer	Плата за удаленный район.
Сумма платы за доставку	rates.shipment_charge_total	float	Сумма платы за доставку.
Плата за обработку склада	rates.warehouse_handling_fee	integer	Плата за обработку склада.
Страховая плата	rates.insurance_fee	integer	Страховая плата.
Плата за обработку DDP	rates.ddp_handling_fee	integer	Плата за обработку DDP, если incoterm является DDP.
Плата за импорт налога	rates.import_tax_charge	integer	Налог на импорт.
Плата за импортную плату	rates.import_duty_charge	integer	Плата за импорт.
Общая плата	rates.total_charge	float	Общая плата.
Выше порогового значения	rates.is_above_threshold	boolean	Указывает, превышает ли пороговое значение.
Эффективные инкотермс	rates.effective_incoterms	string	Эффективные инкотермы.
Предполагаемый налог на импорт	rates.estimated_import_tax	integer	Предполагаемый налог на импорт.
Предполагаемый импортный сбор	rates.estimated_import_duty	integer	Предполагаемый импортный сбор.
Курьер делает пикап	rates.courier_does_pickup	boolean	Будет ли курьер забрать.
URL-адрес dropoff для курьера	rates.courier_dropoff_url	string	URL-адрес раскрывающегося url-адреса курьера.
Рейтинг отслеживания	rates.tracking_rating	integer	Рейтинг отслеживания.
Получатель оплаты	rates.payment_recipient	string	Получатель оплаты.
Примечания курьера	rates.courier_remarks	string	Примечания курьера.
Валюта	rates.currency	string	Валюта.
Имя	rates.box.name	string	Имя.
Length	rates.box.length	integer	Длина.
Ширина	rates.box.width	integer	Ширина.
Высота	rates.box.height	integer	Высота.
Минимальная плата за сбор	rates.minimum_pickup_fee	integer	Минимальная плата за сбор.
Description	rates.title	string	Описание.
Полное описание	rates.full_description	string	Полное описание.

Создание отгрузки

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

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

Параметры

Имя	Ключ	Тип	Описание
Address	line_1	string	Адрес.
Строка адреса 2	line_2	string	Адресная строка 2.
Государство	state	string	Государство.
Город	city	string	Город.
Почтовый индекс	postal_code	string	Почтовый индекс.
Код страны	country_alpha2	string	Код страны.
Имя контактного лица	contact_name	string	Имя контакта.
Название компании	company_name	string	Название компании.
Контактный телефон	contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	contact_email	string	Адрес электронной почты контакта.
Address	line_1	string	Адрес.
Строка адреса 2	line_2	string	Адресная строка 2.
Государство	state	string	Государство.
Город	city	string	Город.
Почтовый индекс	postal_code	string	Почтовый индекс.
Код страны	country_alpha2	string	Код страны.
Имя контактного лица	contact_name	string	Имя контакта.
Название компании	company_name	string	Название компании.
Контактный телефон	contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	contact_email	string	Адрес электронной почты контакта.
Address	line_1	string	Адрес.
Строка адреса 2	line_2	string	Адресная строка 2.
Государство	state	string	Государство.
Город	city	string	Город.
Почтовый индекс	postal_code	string	Почтовый индекс.
Код страны	country_alpha2	string	Код страны.
Имя контактного лица	contact_name	string	Имя контакта.
Название компании	company_name	string	Название компании.
Контактный телефон	contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	contact_email	string	Адрес электронной почты контакта.
Address	line_1	string	Адрес.
Строка адреса 2	line_2	string	Адресная строка 2.
Государство	state	string	Государство.
Город	city	string	Город.
Почтовый индекс	postal_code	string	Почтовый индекс.
Код страны	country_alpha2	string	Код страны.
Имя контактного лица	contact_name	string	Имя контакта.
Название компании	company_name	string	Название компании.
Контактный телефон	contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	contact_email	string	Адрес электронной почты контакта.
Установка в качестве жилого	set_as_residential	boolean	Задано ли значение как жилое.
Налоговый идентификатор получателя	consignee_tax_id	string	Идентификатор налога получателя.
Справочник по EEI	eei_reference	string	Справочник по EEI.
Incoterms	incoterms	string	Incoterms.
Застраховано	is_insured	boolean	Является ли застраховано.
Страховая сумма	insured_amount	integer	Страховая сумма.
Застрахованная валюта	insured_currency	string	Застрахованная валюта.
Имя платформы	platform_name	string	Имя платформы.
Номер заказа платформы	platform_order_number	string	Номер заказа платформы.
Список тегов заказа	order_tag_list	array of string	Список тегов заказа.
Заметки о продавце	seller_notes	string	Заметки продавца.
Заметки покупателя	buyer_notes	string	Покупатель отмечает.
Выбранный идентификатор курьера	selected_courier_id	string	Выбранный идентификатор курьера.
Разрешить резервный резерв курьера	allow_courier_fallback	boolean	Следует ли разрешить курьеру резервную передачу.
Применение правил доставки	apply_shipping_rules	boolean	Применяются ли правила доставки.
Weight	weight	string	Вес.
Измерения	dimensions	string	Измерения.
Формат	format	string	Формат.
Этикетка	label	string	Метка.
Коммерческий счет	commercial_invoice	string	Коммерческий счет.
Упаковка скольжения	packing_slip	string	Скольжение упаковки.
Купить метку	buy_label	boolean	Покупается ли метка.
Купить метку синхронной	buy_label_synchronous	boolean	Покупается ли метка синхронно.
Общий фактический вес	total_actual_weight	float	Общий фактический вес.
Slug	slug	string
Length	length	integer	Длина.
Ширина	width	integer	Ширина.
Высота	height	integer	Высота.
Description	description	string	Описание.
Категория	category	string	Категория.
Артикул (SKU)	sku	string	Номер SKU.
Количество	quantity	integer	Количество.
Length	length	string	Длина.
Ширина	width	string	Ширина.
Высота	height	string	Высота.
Фактический вес	actual_weight	integer	Фактический вес.
Объявленная валюта	declared_currency	string	Объявленная валюта.
Объявленная таможенные значения	declared_customs_value	integer	Объявленная таможенная стоимость.

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

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.
Errors	errors	array of	Ошибки.
Идентификатор отгрузки Easyship	shipment.easyship_shipment_id	string	Идентификатор доставки Easyship.
Создано в	shipment.created_at	string	Создано в.
Обновлено в	shipment.updated_at	string	При обновлении по адресу.
Платная метка	shipment.label_paid_at	string	Метка заплатила.
Метка, созданная в	shipment.label_generated_at	string	Метка, созданная по адресу.
Заказ создан в	shipment.order_created_at	string	Заказ, созданный по адресу.
Address	shipment.origin_address.line_1	string	Адрес.
Строка адреса 2	shipment.origin_address.line_2	string	Адресная строка 2.
Государство	shipment.origin_address.state	string	Государство.
Город	shipment.origin_address.city	string	Город.
Почтовый индекс	shipment.origin_address.postal_code	string	Почтовый индекс.
Код страны	shipment.origin_address.country_alpha2	string	Код страны.
Имя контактного лица	shipment.origin_address.contact_name	string	Имя контакта.
Название компании	shipment.origin_address.company_name	string	Название компании.
Контактный телефон	shipment.origin_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipment.origin_address.contact_email	string	Адрес электронной почты контакта.
Address	shipment.sender_address.line_1	string	Адрес.
Строка адреса 2	shipment.sender_address.line_2	string	Адресная строка 2.
Государство	shipment.sender_address.state	string	Государство.
Город	shipment.sender_address.city	string	Город.
Почтовый индекс	shipment.sender_address.postal_code	string	Почтовый индекс.
Код страны	shipment.sender_address.country_alpha2	string	Код страны.
Имя контактного лица	shipment.sender_address.contact_name	string	Имя контакта.
Название компании	shipment.sender_address.company_name	string	Название компании.
Контактный телефон	shipment.sender_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipment.sender_address.contact_email	string	Адрес электронной почты контакта.
Address	shipment.return_address.line_1	string	Адрес.
Строка адреса 2	shipment.return_address.line_2	string	Адресная строка 2.
Государство	shipment.return_address.state	string	Государство.
Город	shipment.return_address.city	string	Город.
Почтовый индекс	shipment.return_address.postal_code	string	Почтовый индекс.
Код страны	shipment.return_address.country_alpha2	string	Код страны.
Имя контактного лица	shipment.return_address.contact_name	string	Имя контакта.
Название компании	shipment.return_address.company_name	string	Название компании.
Контактный телефон	shipment.return_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipment.return_address.contact_email	string	Адрес электронной почты контакта.
Address	shipment.destination_address.line_1	string	Адрес.
Строка адреса 2	shipment.destination_address.line_2	string	Адресная строка 2.
Государство	shipment.destination_address.state	string	Государство.
Город	shipment.destination_address.city	string	Город.
Почтовый индекс	shipment.destination_address.postal_code	string	Почтовый индекс.
Код страны	shipment.destination_address.country_alpha2	string	Код страны.
Имя контактного лица	shipment.destination_address.contact_name	string	Имя контакта.
Название компании	shipment.destination_address.company_name	string	Название компании.
Контактный телефон	shipment.destination_address.contact_phone	string	Номер телефона контакта.
Контактный адрес электронной почты	shipment.destination_address.contact_email	string	Адрес электронной почты контакта.
Имя платформы	shipment.order_data.platform_name	string	Имя платформы.
Номер заказа платформы	shipment.order_data.platform_order_number	string	Номер заказа платформы.
Список тегов заказа	shipment.order_data.order_tag_list	array of string	Список тегов заказа.
Заметки о продавце	shipment.order_data.seller_notes	string	Заметки продавца.
Заметки покупателя	shipment.order_data.buyer_notes	string	Покупатель отмечает.
Установка в качестве жилого	shipment.set_as_residential	boolean	Задано ли значение как жилое.
Налоговый идентификатор получателя	shipment.consignee_tax_id	string	Идентификатор налога получателя.
Справочник по EEI	shipment.eei_reference	string	Справочник по EEI.
Incoterms	shipment.incoterms	string	Incoterms.
Застраховано	shipment.insurance.is_insured	boolean	Является ли застраховано.
Страховая сумма	shipment.insurance.insured_amount	integer	Страховая сумма.
Застрахованная валюта	shipment.insurance.insured_currency	string	Застрахованная валюта.
Количество посылок	shipment.parcels_count	integer	Количество посылок.
Участков	shipment.parcels	array of object
Общий фактический вес	shipment.parcels.total_actual_weight	float	Общий фактический вес.
Общая стоимость таможенных правил	shipment.parcels.total_customs_value	float	Общая таможенная стоимость.
Общий размерный вес	shipment.parcels.total_dimensional_weight	float	Общий размерный вес.
Общий объем тома	shipment.parcels.total_volumetric_weight	float	Общий объемный объем.
Идентификатор	shipment.parcels.box.id	string	Уникальный идентификатор.
Slug	shipment.parcels.box.slug	string	Слизь.
Length	shipment.parcels.box.length	integer	Длина.
Ширина	shipment.parcels.box.width	integer	Ширина.
Высота	shipment.parcels.box.height	integer	Высота.
items	shipment.parcels.items	array of object
Description	shipment.parcels.items.description	string	Описание.
Категория	shipment.parcels.items.category	string	Категория.
Артикул (SKU)	shipment.parcels.items.sku	string	Номер SKU.
Количество	shipment.parcels.items.quantity	integer	Количество.
Фактический вес	shipment.parcels.items.actual_weight	integer	Фактический вес.
Размерный вес	shipment.parcels.items.dimensional_weight	integer	Размерный вес.
Объемный вес	shipment.parcels.items.volumetric_weight	integer	Объемный вес.
Исходная валюта	shipment.parcels.items.origin_currency	string	Исходная валюта.
Стоимость происхождения таможенных правил	shipment.parcels.items.origin_customs_value	integer	Исходная таможенные значения.
Объявленная валюта	shipment.parcels.items.declared_currency	string	Объявленная валюта.
Объявленная таможенные значения	shipment.parcels.items.declared_customs_value	integer	Объявленная таможенная стоимость.
Length	shipment.parcels.items.dimensions.length	integer	Длина.
Ширина	shipment.parcels.items.dimensions.width	integer	Ширина.
Высота	shipment.parcels.items.dimensions.height	integer	Высота.
Общая стоимость таможенных правил	shipment.total_customs_value	float	Общая таможенная стоимость.
Общий фактический вес	shipment.total_actual_weight	float	Общий фактический вес.
Общий размерный вес	shipment.total_dimensional_weight	float	Общий размерный вес.
Общий объем тома	shipment.total_volumetric_weight	float	Общий объемный объем.
Состояние отгрузки	shipment.shipment_state	string	Состояние отгрузки.
Состояние выбора	shipment.pickup_state	string	Состояние сбора.
Состояние доставки	shipment.delivery_state	string	Состояние доставки.
Состояние метки	shipment.label_state	string	Состояние метки.
Состояние хранилища	shipment.warehouse_state	string	Состояние хранилища.
Отслеживание	shipment.trackings	array of object
Номер отслеживания	shipment.trackings.tracking_number	string	Номер отслеживания.
Локальный номер отслеживания	shipment.trackings.local_tracking_number	string	Номер локального отслеживания.
Альтернативный номер отслеживания	shipment.trackings.alternate_tracking_number	string	Альтернативный номер отслеживания.
Номер ноги	shipment.trackings.leg_number	integer	Номер ноги.
Обработчик	shipment.trackings.handler	string	Обработчик.
Отслеживание состояния	shipment.trackings.tracking_state	string	Состояние отслеживания.
URL-адрес страницы отслеживания	shipment.tracking_page_url	string	URL-адрес страницы отслеживания.
Документы о доставке	shipment.shipping_documents	array of object
Категория	shipment.shipping_documents.category	string	Категория.
Обязательно	shipment.shipping_documents.required	boolean	Требуется ли это.
Размер страницы	shipment.shipping_documents.page_size	string	Размер страницы.
Формат	shipment.shipping_documents.format	string	Формат.
Строки в кодировке Base64	shipment.shipping_documents.base64_encoded_strings	array of string	Строки в кодировке Base64.
URL	shipment.shipping_documents.url	string	URL-адрес.
Валюта	shipment.currency	string	Валюта.
Идентификатор	shipment.selected_courier.id	string	Уникальный идентификатор.
Ставки	shipment.rates	array of object
Идентификатор курьера	shipment.rates.courier_id	string	Идентификатор курьера.
Имя курьера	shipment.rates.courier_name	string	Имя курьера.
Минимальное время доставки	shipment.rates.min_delivery_time	integer	Минимальное время доставки.
Максимальное время доставки	shipment.rates.max_delivery_time	integer	Максимальное время доставки.
Значение для ранжирования денег	shipment.rates.value_for_money_rank	integer	Значение для денежного ранга.
Ранг времени доставки	shipment.rates.delivery_time_rank	integer	Ранг времени доставки.
Плата за доставку	shipment.rates.shipment_charge	float	Плата за доставку.
Дополнительная плата за топливо	shipment.rates.fuel_surcharge	float	Плата за топливо.
Дополнительная плата за удаленный район	shipment.rates.remote_area_surcharge	integer	Плата за удаленный район.
Превышенная дополнительная плата	shipment.rates.oversized_surcharge	integer	Сверхоценная плата.
Дополнительная плата за дополнительные услуги	shipment.rates.additional_services_surcharge	integer	Дополнительная плата за услуги.
Полная плата за жилье	shipment.rates.residential_full_fee	integer	Жилая полная плата.
Плата за жилье с скидкой	shipment.rates.residential_discounted_fee	integer	Плата за жилье с скидкой.
Сумма платы за доставку	shipment.rates.shipment_charge_total	float	Сумма платы за доставку.
Плата за обработку склада	shipment.rates.warehouse_handling_fee	integer	Плата за обработку склада.
Страховая плата	shipment.rates.insurance_fee	integer	Страховая плата.
Налог с продаж	shipment.rates.sales_tax	integer	Налог на продажу.
Налог на продажу в провинции	shipment.rates.provincial_sales_tax	integer	Налог на продажу в провинции.
Плата за обработку DDP	shipment.rates.ddp_handling_fee	integer	Плата за обработку DDP.
Плата за импорт налога	shipment.rates.import_tax_charge	integer	Изменение налога на импорт.
Плата за импортную плату	shipment.rates.import_duty_charge	integer	Плата за импорт.
Общая плата	shipment.rates.total_charge	float	Общая плата.
Выше порогового значения	shipment.rates.is_above_threshold	boolean	Указывает, превышает ли пороговое значение.
Incoterms	shipment.rates.incoterms	string	Incoterms.
Предполагаемый налог на импорт	shipment.rates.estimated_import_tax	integer	Предполагаемый налог на импорт.
Предполагаемый импортный сбор	shipment.rates.estimated_import_duty	integer	Предполагаемый импортный сбор.
Доступные параметры передачи	shipment.rates.available_handover_options	string	Доступные параметры передачи.
Рейтинг отслеживания	shipment.rates.tracking_rating	integer	Рейтинг отслеживания.
Рейтинг Easyship	shipment.rates.easyship_rating	integer	Рейтинг Easyship.
Примечания курьера	shipment.rates.courier_remarks	string	Примечания курьера.
Получатель оплаты	shipment.rates.payment_recipient	string	Получатель оплаты.
Code	shipment.rates.discount.code	string	Код.
Сумма	shipment.rates.discount.amount	integer	Сумма.
Истекает в	shipment.rates.discount.expires_at	string	Срок действия истекает.
Процент	shipment.rates.discount.percentage	string	Процент.
Эффективные инкотермс	shipment.rates.effective_incoterms	string	Эффективные инкотермы.

Список всех полей

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

Извлекает список всех доступных ящиков курьера.

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

Имя	Путь	Тип	Описание
Коробки	boxes	array of object
Идентификатор	boxes.id	string	Уникальный идентификатор.
Имя курьерского зонтика	boxes.courier_umbrella_name	string	Имя курьерского зонтика.
Имя	boxes.name	string	Имя.
Slug	boxes.slug	string	Слизь.
Внешняя длина	boxes.outer_length	float	Внешняя длина.
Внешняя ширина	boxes.outer_width	float	Внешняя ширина.
Внешняя высота	boxes.outer_height	float	Внешняя высота.
Weight	boxes.weight	float	Вес.

Удаление отгрузки (V1)

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

Удаление и получение подтверждения удаления отгрузки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор отгрузки Easyship	easyship_shipment_id	True	string	Идентификатор доставки Easyship.

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

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние.