Получить данные о локации по штрих-коду товара

Метод вернет следующие данные:

• Данные о локации location
• График доступности локации workTimeProfile
• Гайд по доступу к локации (код доступа к домофону) pointAccess
• Идентификатор постамата idPoint

При запросе к методу, в части required полей, доступен выбор обязательного поля courierExternalId, либо postamatAccessCode. Возможно использование обоих полей в запросе.

POST /order/detail

Инициатор запроса внешняя система

Header parameters

	desc	type
X-Smartix-Api-Key	Ключ авторизации	string	required
Content-Type	Со значением application/json	string	required

Request body

	desc	type
barcode	Штрих-код посылки	string	required
courierExternalId	Идентификатор курьера внешней системы	string	no required
postamatAccessCode	Код доступа курьера на постамате	string	no required

Пример запроса

curl -X 'POST' \
  'https://api-stage.selftech.ru/postamat/marketplace/v4/auth/delivery/order/detail' \
  -H 'accept: */*' \
  -H 'X-Smartix-Api-Key: KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "barcode": "ORD696436",
    "courierExternalId": "1412ABC03",
    "postamatAccessCode": "343563"
}'

Коды ответов

200 - ОК

Response schema

	desc	type
idPoint	Сообщение ошибки	string
orderNumber	Номер заказа (либо штрих-код посылки)	string
workTimeProfile	Профиль рабочего расписания	object
location	Местоположение	object
pointAccess	Информация о доступе на локацию	object
holdedCells	Информация по занятым ячейкам	array
holdUntil	Дата хранения товара в ячейках	datetime

400 - Bad request

Response schema

	desc	type
message	Сообщение ошибки	string
resultCode	Ответ сервера: 203 - Logist not found; 210 - Courier route not found; 200 - Order not found;	int32

{
"message": "Logist not found",
"resultCode": 203
}

{
"message": "Courier route not found",
"resultCode": 210
}

{
"message": "Order not found",
"resultCode": 200
}

401 - Unauthorized
500 - Internal server error

Описание объектов ответа

order object

	desc	type
idPoint	Уникальный идентификатор постамата	int32
orderNumber	Идентификатор заказа во внешней системе	string
holdUntil	Дата/время окончания хранения заказа (Отображается только в статусе "Заложено курьером)	datetime
state	Идентификатор статуса заказа	int

workTimeProfile object

	desc	type
id	Уникальный идентификатор постамата	int32
name	Наименование	string
active	Флаг активности расписания	boolean
lastUpdate	Время последнего обновления записи	datetime
monday	Информация о времени рабочего дня	object
tuesday	Информация о времени рабочего дня	object
wednesday	Информация о времени рабочего дня	object
thursday	Информация о времени рабочего дня	object
saturday	Информация о времени рабочего дня	object
sunday	Информация о времени рабочего дня	object
everyDay	Информация о времени всех дней (возращается только при отсутвии описании по дням)	object
preHoliday	Информация о времени всех дней (возращается только при отсутвии описании по дням)	object
holiday	Информация о времени всех дней (возращается только при отсутвии описании по дням)	object

location object

	desc	type
id	Идентификатор локации	int32
city	Город	string
street	Улица	string
house	Номер дома	string
building	Строение	string
housing	Корпус	string
entrance	Подъезд	string
officeNum	Номер офиса	string
route	Информация как доехать до локации	string
latitude	Широта	double
longitude	Долгота	double
fullAddress	Полный адрес постамата	string

pointAccess object

	desc	type
privateAccess	Признак ограничения доступа к локации	boolean
accessGuide	Инструкция по доступу	string
accessCode	Персональный код домофона курьера (необязательно)	string

holdedCells array

	desc	type
cellId	Номер ячейки постамата	int32
barcodes	Штрих-коды посылок, размещенных в ячейке	array

Пример ответа

{
  "idPoint": 223,
  "orderNumber": "КА-123456",
  "workTimeProfile": {
    "id": 13,
    "name": "Ежедневно/9-18",
    "active": true,
    "lastUpdate": "2000-01-23T04:56:07+00:00",
    "monday": {
      "start": "09:00",
      "end": "18:00"
    },
    "tuesday": {
      "start": "09:00",
      "end": "18:00"
    },
    "wednesday": {
      "start": "09:00",
      "end": "18:00"
    },
    "thursday": {
      "start": "09:00",
      "end": "18:00"
    },
    "friday": {
      "start": "09:00",
      "end": "18:00"
    },
    "saturday": {
      "start": "09:00",
      "end": "18:00"
    },
    "sanday": {
      "start": "09:00",
      "end": "18:00"
    },
    "preHoliday": {
      "start": "09:00",
      "end": "18:00"
    },
    "holiday": {
      "start": "09:00",
      "end": "18:00"
    }
  },
  "location": {
    "id": 12,
    "city": "Москва",
    "street": "Павловский тракт",
    "house": "2",
    "building": "5",
    "housing": "4",
    "entrance": "6",
    "officeNum": "544",
    "latitude": 0.8008281904610115,
    "longitude": 6.027456183070403,
    "fullAddress": "Россия, Москва, Малахова 146В",
    "route": "Гипермаркет Огни. Транспорт: Автобус №60, 1; Маршрутное такси №50, 54. Остановка Малахова."
  },
  "pointAccess": {
    "privateAccess": true,
    "accessGuide": "Код домофона 23В7621"
  },
  "holdedCells": [
    {
      "cellId": 1894,
      "barcodes": [
        "101476"
      ]
    }
  ],
  "holdUntil": "2025-08-03T11:38:12.139144+03:00[Europe/Moscow]",
  "state": 7
}

Расшифровка статусов

state	name
0	Новый (Ожидает загрузки)
2	Клиент получил
3	Курьер загрузил
4	Курьер забрал
5	Отменен (До загрузки курьером)
6	Инициирован возврат (Технический статус. В течение 15 минут после отмены или окончания срока хранения)
7	Ожидает возврата