API - автоматизированное размещение заказов.

Запросы могут отправляться по протоколу HTTP методом GET или POST.

Формат запроса:

https://api.p5s.ru/order.php?ApiKey=****&TestMode=*&RollBack=*&order...

Параметры запроса:

• ApiKey - все запросы должны содержать ApiKey. Этот параметр идентифицирует Вас у нас в системе и по нему мы понимаем от кого пришел запрос. Узнать Ваш ApiKey Вы можете в Вашем личном кабинете - API и выгрузки.
• TestMode - не обязательный параметр. Может принимать значения 0 и 1. Если параметр имеет значение 1, т.е. тестовый режим включен, то запросы принимаются, данные проверяются и выдается ответ о валидности данных, но сам заказ не размещается. По умолчанию этот параметр равен 0.
• RollBack - не обязательный параметр. Может принимать значения 1 и 2. Параметр указывает системе - что делать в случае если не все запрашиваемые позиции найдены, или например какой-то из позиций не достаточное количество.
  Если параметр имеет значение 1, то система разместит заказ в любом случае. Не найденный товары будут проигнорированы. А товары количество, которых меньше нужного, будут добавлены в заказ в том количестве в каком они есть на складе.
  Если параметр имеет значение 2, то система разместит заказ только, если найдены все запрашиваемые позиции, и все товары есть достаточном для заказа количестве.
  По умолчанию этот параметр равен 1.
• order - это обязательный параметр. Он содержит содержать пары вида: <aID>-<qty>. Пары отделяются друг от друга запятыми.
  aID - это идентификатор товарного предложения. Более подробно - что такое aID?
  qty - количество товара которое нужно добавить в заказ.
• packType - тип комплектации. Не обязательный параметр. Если параметр не указан, используется значение указанное в параметрах клиента на странице Настройки заказа. Возможные значения (целое число):
  1 - без комлектации,
  2 - комплектация в коробку (60 руб.), если товары в заказе имеют нестандартные размеры, то он будет упакован в нестандартную коробку (90 руб.)
  3 - комплектация в сейф-пакет (40 руб.).
• orderType - тип заказа. Не обязательный параметр, используется при заказе на маркетплейсы. Возможные значения (целое число):
  10 - Яндекс Маркет FBS,
  12 - Яндекс Маркет FBO,
  13 - Яндекс Маркет DBS,
  14 - Wildberries FBO,
  15 - Wildberries FBS,
  17 - Озон FBO,
  18 - Озон FBS,
  22 - Мегамаркет FBS.
  
• ExtOrderID - не обязательный параметр. Внутренний номер заказа в Вашей системе учета. Должно быть уникальным значением в рамках Вашего интернет-магазина!
• userComment - комментарий к заказу. Не обязательный параметр. Тут можно указать разнообразные дополнительные сведения.  Если указать в значении этого поля слово "тест" (userComment=тест), то заказ будет размещен в нашей системе в статусе "Принят", но не пойдет в дальнейшую обработку. Главное отличие от TestMode=1 в том, что заказ реально размещается.

Результаты работы

По результатам работы система выдает структурированный ответ в формате XML.

Если заказ размещен корректно, то в ответе будет приведен номер размещенного заказа и его состав.

В случае возникновения ошибок в параметре ErrorItems приводится подробная диагностика по каждой проблемной паре <aID>-<qty>.

Заказы размещаются с учетом Вашей клиентской скидки.

Параметры ответа:

• ResultStatus - статус результата выполнения запроса. Может принимать следующие значения:
  1 - "Ok", Запрос выполнен успешно. Заказ размещен.
  2 - "Bad key", Проверьте корректность Вашего ApiKey.
  3 - "Bad order request", Не корректные данные в поле order.
  4 - "Order do not placed. Some items not at stock OR some problem in aID.", Заказ не размещен, Либо каких-то товаров недостаточное количество на нашем складе, либо какие-то aID не найдены в нашей системе.
  5 - "TestMode. Data was checked. Order have NOT placed.". Включен тестовый режим. Данные проверены, но заказ не размещается.
• ResultStatusMsg - текстовое описание статуса результата выполнения запроса.
• timestamp - дата/время выполнения запроса в формате "Y-m-d H:i:s".
• orderID - номер заказа у нас в системе.
• totalSum - полная оптовая стоимость заказа (рубли).
• OrderItems - массив, содержащий детальную информацию о составе заказа.
• pickupDate - плановая дата отгрузки заказа с нашего склада.
• ErrorItems - массив, содержащий детальную информацию об ошибках в составе заказа. Параметр передаётся только в случае ошибок в составе заказа.

Параметры orderID, totalSum, OrderItems, pickupDate передаются только в случае успешного выполнения запроса.

Если у Вашего программиста будут вопросы/предложения пусть он свяжется c нами, мы обязательно Вам поможем.