Получение информации по заказу #
Адрес метода #
Параметры запроса #
| Параметр | Описание | Тип | Обязательный | Пример |
|---|---|---|---|---|
| orderId | ID заказа в системе ApiShip, по которому нужна информация | число | обязательный | 11000010 |
Пример запроса #
# GET параметры
# orderID = 11000010
curl -X GET --header 'Accept: application/json'
--header 'Authorization: XXXXXXXXXXXXXXXXXXXX'
'https://api.apiship.ru/v1/orders/11000010'
Параметры ответа #
| Раздел | Параметр | Описание | Тип | Пример |
|---|---|---|---|---|
| order | ||||
| orderId | ID заказа | Число | 11000010 | |
| providerNumber | Номер заказа в системе службы доставки. Если СД выдает диапазон номеров заказа | Строка | 11e51r6 | |
| additionalProviderNumber | Дополнительный номер заказа в системе службы доставки | Строка | 21309812039812 | |
| clientNumber | Номер заказа в системе клиента. Может быть переиспользован, если отменить или удалить заказ. | Строка | 123-456 | |
| description | Коментарий к заказу | Строка | Важный заказ | |
| barcode | Штрих-код заказа. Если передается заказ с указанием мест (Place), то ШК надо указывать в параметре place.barcode | Строка | 123456 | |
| weight | Вес всего заказа в граммах | Число | 100 | |
| height | Высота заказа в сантиметрах | Число | 10 | |
| length | Длина заказа в сантиметрах | Число | 10 | |
| width | Ширина заказа в сантиметрах | Число | 10 | |
| providerKey | Код службы доставки | Строка | cdek | |
| providerConnectId | ID подключения к СД. Используется когда к одному аккаунту ApiShip подключено несколько договоров с одной и той же СД | Число | 12 | |
| pickupType | Тип забора груза 1 - от двери клиента 2 – клиент привозит заказ на склад СД | Число | 1 | |
| deliveryType | Тип доставки 1 - до двери 2 – до ПВЗ | Число | 1 | |
| tariffId | Тариф службы доставки по которому осуществляется доставка | Число | 1 | |
| pointInId | ID пункта приема заказов из метода /lists/points. Обязательно если отгрузка на склад службы доставки. | Число | 32 | |
| pointOutId | ID пункта выдачи заказов из метода /lists/points. Обязательно если доставка до ПВЗ | Число | 21 | |
| pickupDate | Планируемая дата передачи заказа в СД (вызова курьера) | Дата | 2020-01-31 | |
| pickupTimeStart | Начальное время передачи заказа в СД (вызова курьера) | Время | 10:00 | |
| pickupTimeEnd | Конечное время передачи заказа в СД (вызова курьера) | Время | 18:00 | |
| deliveryDate | Желаемая дата доставки | Дата | 2020-01-31 | |
| deliveryTimeStart | Начальное время доставки | Время | 10:00 | |
| deliveryTimeEnd | Конечное время доставки | Время | 18:00 | |
| cost | ||||
| assessedCost | Оценочная стоимость / сумма страховки (в рублях) | Число | 100,12 | |
| codCost | Сумма наложенного платежа с учетом НДС (в рублях) | Число | 98,21 | |
| deliveryCost | Стоимость доставки с получателя. codCost должен содержать в себе эту сумму. | Число | 50,12 | |
| deliveryCostVat | Процентная ставка НДС (-1 - Без НДС, 0 - НДС 0%, 10 - НДС 10%, 20 - НДС 20%, 22 - НДС 22%) | Число | 22 | |
| isDeliveryPayedByRecipient | Флаг для указания стороны, которая платит за услуги доставки (0-отправитель, 1-получатель) | Число | 1 | |
| sender | ||||
| phone | Контактный телефон | Строка | +7(925)111-11-11 | |
brandName | Бренд продавца | Строка | ApiShip | |
| companyName | Название компании | Строка | ООО КНД | |
| companyInn | ИНН компании | Строка | 1234567890 | |
| contactName | ФИО контактного лица | Строка | Иванов Иван | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | Строка | RU | |
| region | Область или республика или край | Строка | Москва | |
| city | Город или населенный пункт | Строка | Москва | |
| street | Улица | Строка | Нижняя Красносельская | |
| house | Дом | Строка | 1a | |
| block | Строение/Корпус | Строка | 1 | |
| office | Офис/Квартира | Строка | 1 | |
| Контактный email адрес | Строка | mail@gmail.com | ||
| addressString | Адрес одной строкой | Строка | 105066, Москва, Нижняя Красносельская улица, 14А | |
| lat | Широта | Число | 55.756499 | |
| lng | Долгота | Число | 37.621864 | |
| postIndex | Почтовый индекс | Строка | 100100 | |
| area | Район | Строка | Кировский | |
| cityGuid | ID города в базе ФИАС | Строка | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| comment | Комментарий | Строка | Позвонить с проходной | |
| recipient | ||||
| phone | Контактный телефон | Строка | +7(925)111-11-11 | |
| companyName | Название компании | Строка | ООО КНД | |
| companyInn | ИНН компании | Строка | 1234567890 | |
| contactName | ФИО контактного лица | Строка | Иванов Иван | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | Строка | RU | |
| region | Область или республика или край | Строка | Москва | |
| city | Город или населенный пункт | Строка | Москва | |
| street | Улица | Строка | Нижняя Красносельская | |
| house | Дом | Строка | 1a | |
| block | Строение/Корпус | Строка | 1 | |
| office | Офис/Квартира | Строка | 1 | |
| Контактный email адрес | Строка | mail@gmail.com | ||
| addressString | Адрес одной строкой | Строка | 105066, Москва, Нижняя Красносельская улица, 14А | |
| lat | Широта | Число | 55.756499 | |
| lng | Долгота | Число | 37.621864 | |
| postIndex | Почтовый индекс | Строка | 100100 | |
| area | Район | Строка | Кировский | |
| cityGuid | ID города в базе ФИАС | Строка | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| comment | Комментарий | Строка | Позвонить с проходной | |
| returnAddress | ||||
| phone | Контактный телефон | Строка | +7(925)111-11-11 | |
| companyName | Название компании | Строка | ООО КНД | |
| contactName | ФИО контактного лица | Строка | Иванов Иван | |
| countryCode | Код страны в соответствии с ISO 3166-1 alpha-2 | Строка | RU | |
| region | Область или республика или край | Строка | Москва | |
| city | Город или населенный пункт | Строка | Москва | |
| street | Улица | Строка | Нижняя Красносельская | |
| house | Дом | Строка | 1a | |
| block | Строение/Корпус | Строка | 1 | |
| office | Офис/Квартира | Строка | 1 | |
| Контактный email адрес | Строка | mail@gmail.com | ||
| addressString | Адрес одной строкой | Строка | 105066, Москва, Нижняя Красносельская улица, 14А | |
| lat | Широта | Число | 55.756499 | |
| lng | Долгота | Число | 37.621864 | |
| postIndex | Почтовый индекс | Строка | 100100 | |
| area | Район | Строка | Кировский | |
| cityGuid | ID города в базе ФИАС | Строка | 0c5b2444-70a0-4932-980c-b4dc0d3f02b5 | |
| comment | Комментарий | Строка | Позвонить с проходной | |
| place | ||||
| placeNumber | Номер места в информационной системе клиента | Строка | 1 | |
| barcode | Штрихкод места | Строка | 011-819 | |
| height | Высота места в сантиметрах | Число | 10 | |
| width | Ширина места в сантиметрах | Число | 10 | |
| length | Длина места в сантиметрах | Число | 10 | |
| weight | Вес места в граммах | Число | 100 | |
| items | Содержимое места | item | ||
| item | ||||
| description | Наименование товара | Строка | Кирпич | |
| quantity | Кол-во товара | Число | 2 | |
| articul | Артикул товара | Строка | 123-456 | |
| barcode | ШК предмета | Строка | 123456 | |
| assessedCost | Оценочная стоимость единицы товара в рублях | Число | 100,20 | |
| cost | Наложенная стоимость товара в рублях | Число | 100,20 | |
| costVat | Процентная ставка НДС (-1 - Без НДС, 0 - НДС 0%, 10 - НДС 10%, 20 - НДС, 22 - НДС 22%) | Число | 22 | |
| weight | Вес единицы товара в граммах | Число | 100 | |
| height | Высота единицы товара в сантиметрах | Число | 10 | |
| length | Длина единицы товара в сантиметрах | Число | 10 | |
| width | Ширина единицы товара в сантиметрах | Число | 10 | |
| markCode | Код маркировки | Строка | 010468006347633 | |
| companyName | Наименование компании поставщика / продавца товара | Строка | ООО "Тест" | |
| companyInn | ИНН поставщика / продавца товара | Строка | 1234567890 | |
| companyPhone | Телефон поставщика / продавца товара | Строка | 79887776655 | |
| photoLinks | Список ссылок на фото товара. Возвращается всегда: сохранённые URL’ы или пустой массив, если фото не задавались | Массив строк | [“https://example.com/img/1.jpg”] | |
| extraParams | ||||
| key | Тип дополнительной услуги | Строка | cdek.InspectionAttachments | |
| value | Значение дополнительной услуги | Строка | 1 | |
| extendedInfo | Получение информации по заказу | |||
| plannedDeliveryDates | История плановых дат доставки от службы доставки, текущая дата — последний элемент. Нет дат — пустой массив. Подробнее | Массив |
Пример данных ответа #
| |
| |
Плановые даты доставки (plannedDeliveryDates) #
Массив plannedDeliveryDates — история плановых дат доставки, которые назначает и переносит служба доставки. Это не deliveryDate из заявки: та остаётся датой, которую вы передали при создании заказа, и не меняется.
- Записи идут в хронологическом порядке: текущая плановая дата — последний элемент.
- Новая запись появляется, только когда служба доставки сообщила другую дату или другое окно времени. Повтор той же даты с тем же окном новую запись не создаёт.
- Дата может сдвинуться как на более поздний, так и на более ранний день — в примере выше заказ сначала перенесли с 26.09 на 24.09, а после неудачной попытки вручения — на 25.09.
- Если служба доставки дат не сообщала, приходит пустой массив
[], а неnull. - В карточке заказа все ключи элемента присутствуют всегда, незаполненные — со значением
null. - В XML-ответе каждый элемент массива — тег
<item>, значениеnull— пустой тег (например,<reason></reason>), пустой массив —<plannedDeliveryDates/>.
Элемент массива #
| Параметр | Описание | Тип | Пример |
|---|---|---|---|
| date | Плановая дата доставки, YYYY-MM-DD | Строка | 2026-09-25 |
| timeStart | Начало окна доставки, HH:MM, местное время получателя. null — служба доставки сообщила только день | Строка | null | 14:00 |
| timeEnd | Конец окна доставки, HH:MM. Совпадает с timeStart — назначено точное время | Строка | null | 18:00 |
| source | Кто назначил дату: provider — служба доставки. Значение calculator (расчётная дата при создании заказа) зарезервировано и пока не приходит | Строка | provider |
| created | Когда ApiShip получил эту дату, ISO 8601 | Строка | 2026-09-24T05:20:41+03:00 |
| createdProvider | Когда дату назначила служба доставки, ISO 8601. null — служба доставки время не сообщила | Строка | null | 2026-09-24T05:20:31+03:00 |
| reason | Причина переноса на эту дату. null — служба доставки причину не сообщила | Объект | null | |
| reason.key | Причина в словаре ApiShip, см. таблицу ниже | Строка | recipientUnavailable |
| reason.name | Название причины в словаре ApiShip | Строка | Получатель недоступен |
| reason.providerCode | Код причины в системе службы доставки. Может быть не числом: у СДЭК для договорённости с получателем это источник согласования, например DAILY_CALL_TASK | Строка | null | 13 |
| reason.providerName | Название причины в системе службы доставки | Строка | null | Контактное лицо отсутствует |
Словарь причин reason.key #
| key | name | Когда |
|---|---|---|
| recipientRequest | Перенос по просьбе получателя | Получатель попросил другую дату или интервал |
| recipientUnavailable | Получатель недоступен | Не дозвонились, получателя не было на месте |
| providerDelay | Задержка на стороне службы доставки | Логистика, сортировка, проблемы курьера |
| addressChanged | Изменён адрес доставки | Сменился адрес, город или пункт выдачи |
| orderChanged | Изменён заказ | Отправитель изменил заказ |
| other | Другая причина | Служба доставки сообщила причину, но она не входит в словарь |
reason: null и reason.key: "other" — разные случаи:
reason: null— служба доставки причину не сообщила. Так же приходит первая дата от службы доставки: это не перенос.other— служба доставки причину сообщила, но ApiShip её не классифицировал. Её текст — вreason.providerName, код — вreason.providerCode. Если для кода службы доставки нет известного названия,providerNameбудетnull.
Словарь может пополняться новыми ключами. Незнакомый ключ обрабатывайте так же, как other.
Текущая дата в статусах и вебхуках #
Текущая плановая дата — последний элемент массива — без истории приходит в блоке orderInfo.plannedDelivery. Форма объекта та же, что у элемента массива.
- Вебхуки ORDER_STATUS, ORDER_NUMBER_UPDATE и PLANNED_DELIVERY_DATE_UPDATE. Пустые поля в тело вебхука не попадают: у заказа без плановой даты нет ключа
plannedDelivery, а внутри объекта нет незаполненныхtimeStart,timeEnd,createdProvider,reason. - Статусные методы. У заказа без плановой даты ключа
plannedDeliveryнет. Незаполненные поля внутри объекта приходят пустой строкой, аreasonбез причины —null.
Чтобы узнавать о переносах без опроса, подпишитесь на вебхук PLANNED_DELIVERY_DATE_UPDATE. Перенос не всегда сопровождается сменой статуса, поэтому по методам статусов его можно не заметить.
Службы доставки #
Плановую дату сейчас передаёт:
- СДЭК — с 23.09.2026. Для доставки до двери это дата и интервал, согласованные с получателем, а пока договорённости нет — плановая дата СДЭК без интервала. Для доставки до пункта выдачи и постамата — плановая дата СДЭК без интервала.
Список пополняется. У заказов других служб доставки массив пока пустой.