Skip to content
Мои токены Поддержка
Чат для вопросов по API Мгновенно ответим на ваши вопросы
api@ati.su Электронная почта техподдержки
Тикетная система Оставить заявку на отдел "Консультанты по интеграции (API)"
api.ati.su - заказы, торги, площадки Наш телеграм-канал
Авторизоваться
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя
Отменить

Методы для работы с площадками погрузки-выгрузки

Добавление или изменение площадки погрузки-выгрузки

Чтобы изменить существующую площадку погрузки-выгрузки, надо передать поле id с ее идентификатором. Если id не передать, то будет создана новая площадка погрузки-выгрузки. В ответ на запрос возвращается созданная или изменённая площадка погрузки-выгрузки.

post /gw/timeslots/api/v1/terminal
Запрос
Модель
{...}
id: integer

Идентификатор площадки погрузки-выгрузки

gates:[{}]

Список ворот площадки погрузки-выгрузки

name*: string

Название площадки погрузки-выгрузки

gates_count*: integer

Количество ворот

loading_type*: enum
[any, gates, up, lateral]

Тип загрузки

date_creation: string

Дата создания площадки погрузки-выгрузки

date_modified: string

Дата изменения площадки погрузки-выгрузки

deleted: boolean

Флаг, указывающий существует ли площадка погрузки-выгрузки или была удалена

is_test: boolean

Флаг, указывающий является ли площадка погрузки-выгрузки тестовой

warehouse*: integer

Идентификатор склада

}
Пример запроса 
curl 'https://api.ati.su/gw/timeslots/api/v1/terminal' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"Тестовая площадка","gates_count":"3","loading_type":"any","warehouse":24540,"schedule":[{"time_from":"00:00","time_to":"23:59","day_of_week":"1"}],"contacts":[{"name":"Имя менеджера склада","phone":"+7 000 000-00-00","country_phone_id":"0","warehouse":34824}]}'
Ответ
200 Возвращается созданная или обновленная площадка погрузки-выгрузки
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"terminal":{...}
"id":35262,
"gates":[],
"schedule":[...],
{...}
"day_of_week":"1",
"time_from":"00:00:00",
"time_to":"23:59:00"
}
],
"contacts":[...],
{...}
"id":35498,
"name":"Имя менеджера склада",
"phone":"+7 000 000-00-00",
"country_phone_id":"0"
}
],
"name":"Тестовая площадка",
"gates_count":3,
"loading_type":"any",
"date_creation":"2023-07-04T08:09:18.676843+03:00",
"date_modified":"2023-07-04T08:09:18.676871+03:00",
"deleted":false,
"is_test":true,
"warehouse":34824
}
}
}
400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение
Модель
ANY-OF
Пример
{...}
"error":"multiple_errors",
"error_list":[...],
{...},
"error":"loading_type",
"reason":"Значения test нет среди допустимых вариантов."
},
{...}
"error":"warehouse",
"reason":"Некорректный тип. Ожидалось значение первичного ключа, получен str."
}
],
"reason":"invalid"
}

Получение площадок погрузки-выгрузки

Возвращается список площадок погрузки и выгрузки пользователя.

get /gw/timeslots/api/v1/terminal
Запрос
Пример запроса 
curl 'https://api.ati.su/gw/timeslots/api/v1/terminal' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
Ответ
200 Возвращаются площадки погрузки-выгрузки
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"count":2,
"terminals":[...]
{...},
"id":35260,
"gates":[],
"schedule":[...],
{...},
"day_of_week":"1",
"time_from":"00:00:00",
"time_to":"23:59:00"
},
{...},
"day_of_week":"2",
"time_from":"00:00:00",
"time_to":"23:59:00"
},
{...},
"day_of_week":"3",
"time_from":"00:00:00",
"time_to":"23:59:00"
},
{...},
"day_of_week":"4",
"time_from":"00:00:00",
"time_to":"23:59:00"
},
{...},
"day_of_week":"5",
"time_from":"00:00:00",
"time_to":"23:59:00"
},
{...},
"day_of_week":"6",
"time_from":"00:00:00",
"time_to":"23:59:00"
},
{...}
"day_of_week":"7",
"time_from":"00:00:00",
"time_to":"23:59:00"
}
],
"contacts":[...],
{...}
"id":35496,
"name":"Имя менеджера склада",
"phone":"+7 000 000-00-00",
"country_phone_id":"0"
}
],
"name":"Площадка",
"gates_count":1,
"loading_type":"any",
"date_creation":"2023-07-04T07:45:11.954912+03:00",
"date_modified":"2023-07-04T07:45:11.954929+03:00",
"deleted":false,
"is_test":false,
"warehouse":34824
},
{...}
"id":35259,
"gates":[],
"schedule":[],
"contacts":[],
"name":"Площадка",
"gates_count":1,
"loading_type":"any",
"date_creation":"2023-07-04T06:57:45.340826+03:00",
"date_modified":"2023-07-04T07:34:58.968527+03:00",
"deleted":true,
"is_test":false,
"warehouse":34823
}
]
}
}

Удаление площадок погрузки-выгрузки

delete /gw/timeslots/api/v1/terminal
Запрос
Модель
{...}
terminal_ids*: [integer]

Список удаляемых площадок погрузки-выгрузки

}
Пример запроса 
curl 'https://api.ati.su/gw/timeslots/api/v1/terminal' \
  -X 'DELETE' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"terminal_ids":[35262]}'
Ответ
200 Возвращается список удаленных площадок погрузки-выгрузки, а также списки ошибок, если таковые возникли
Модель
{...}
ok: boolean
}
Пример
{...}
"ok":true,
"result":{...}
"200":[...],
35262
],
"400":[],
"500":[]
}
}
400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение
Модель
{...}

Одиночная ошибка

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

}
Пример
{...}
"error":"bad request",
"reason":"Необходимо передать список terminal_ids",
"details":null
}