API - получение информации о состоянии заказа.

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

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

https://api.p5s.ru/ds_get_order_data.php?ApiKey=****&ExtOrderID=*...&orderID=*...

Обязательные параметры запроса:

• ApiKey - все запросы должны содержать ApiKey. Этот параметр идентифицирует Вас у нас в системе и по нему мы понимаем от кого пришел запрос. Узнать Ваш ApiKey Вы можете в Вашем личном кабинете - API и выгрузки.
• ExtOrderID и/или orderID - в запросе должен быть, как минимум, один из этих параметров.
  ExtOrderID - идентификатор заказа в Вашем интернет-магазине. Если запрашивается информация о нескольких заказах, то идентификаторы отделяются друг от друга запятой.
  oderID - идентификатор заказа в нашей системе. Если запрашивается информация о нескольких заказах, то идентификаторы отделяются друг от друга запятой.



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

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

Поле ResultStatus - говорит о результате выполнения запроса. Может принимать следующие значения:

• 1 - "Ok", Запрос выполнен успешно.
• 2 - "Bad key", Проверьте корректность Вашего ApiKey.
• 20 - "Request do not have any ExtOrderID or orderID.", в запросе нет ни одного идентификатора заказа.
• 21 - "Some orders was not found.", для некоторых идентификаторов заказов из запроса заказы не найдены. В этом случае в ответе будет приведен блок NotFoundOrders, в котором будут указаны идентификаторы заказы по которым не найдены.



Блок Orders - содержит подробную информацию по каждому из найденных заказов:

• orderID - идентификатор заказа в нашей системе.
• ExtOrderID - идентификатор заказа в Вашем интернет-магазине.
• ExtDateOfAdded - дата размещения заказа в вашем интернет-магазине.
• ExtOrderPaid - статус оплаты заказа. Может иметь два значения:
  1 - «заказ оплачен Мерчанту»;
  0 - «оплата заказа при получении».
• ExtOrderTotal - число. Стоимость товаров в заказе для конечного получателя.
• ExtDeliveryCost - число. Стоимость доставки для конечного получателя.
• dsDeliveryPriceTo - число. Себестоимость доставки до покупателя. В процессе выполнения эта поле пустое, т.к. точную стоимость доставки мы узнаем после завершения выполнения заказа и получения отчётных документов от службы доставки.
• dsDeliveryPriceBack - число. Себестоимость возврата заказа от покупателя. В процессе выполнения эта поле пустое, т.к. точную стоимость возврата заказа мы узнаем после завершения осуществления возврата заказа и получения отчётных документов от службы доставки.
• dsDeliveryAgentMoney - число. Сумма агентского вознаграждения, в случае если мы принимаем в оплату в Ваш адрес по этому заказу.
• dsDelivery - способ доставки. Целое число. Варианты значений:
  1 - Наш курьер по Москве;
  2 - Почта РФ;
  4 - Самовывоз Москва, м. Автозаводская;
  7 - Курьер по Санкт-Петербург (Maxi-post). - не поддерживается с мая 2018 года.
  10 - Курьер по России (СДЭК до двери).
  
  
• dsFio - ФИО покупателя.
• dsPostcode - почтовый индекс.
• dsCountry - страна.
• dsArea - область.
• dsCity - название населенного пункта.
• dsStreet - улица.
• dsHouse - номер дома, строение, корпус.
• dsFlat - номер квартиры.
• dsEmail - email покупателя.
• dsMobPhone - телефон покупателя.
• dsDeliveryDate - пожелания покупателя по дате/времени доставки заказа.
• dsMetro - станция метро, если применимо.
• dsComments - комментарии покупателя к заказу.
• orderDate - дата и время размещения заказа у нас в системе.
• pickupDate - плановая дата отгрузки заказа с нашего склада.
• status - текущий статус заказа. Целое число. Варианты значений:
  1 - Принят;
  2 - Обработка на складе;
  3 - Ожидает подтверждения;
  4 - Товар забронирован;
  5 - Готов к отгрузке;
  6 - Выслан на почту;
  7 - Оплачен и доставлен;
  8 - Отказ;
  9 - Комплектация товара на складе;
  10 - Злонамеренный отказ;
  11 - Отправлен с курьером;
  12 - Отгружен. Ожидаем оплату;
  13 - Удален.
• orderTotal - число. Оптовая стоимость товаров в заказе.
• OrderItems - блок с информацией о составе заказа. О каждой позиции в заказе приведена следующая информация:
  prodID - наш внутренний идентификатор модели;
  aID - это идентификатор товарного предложения. Более подробно - что такое aID?
  qty - количество товара в заказе;
  ds_price - розничная цена этой позиции для конечного покупателя;
  itemcost - оптовая цена этой позиции.
• postData - блок с информацией о трекинге отправления в службе доставки. Блок выводится только для внешних служб доставки. Блок выводится только в случае если отправление уже в пути. Блок содержит следующие данные:
  PostCode - идентификаторв отправления в службе доставки.
  PostStatusName - статус отправления в службе доставки.
  TrackingUrl - адрес, где можно получить информацию о текущем состоянии отправления.
• StatusHistory - блок с хронологией изменения статуса заказа. Тут приведена информация о том - когда, в каком статусе находился заказ:
  status_id - число, идентификатор статуса заказа. Вариант значений совпадают со значениями поля status приведенного выше.
  date - дата и время когда заказ был переведён в этот статус.
  label - текстовое значение статуса.
• MoneyHistory - блок с финансовыми операциями по этому заказу. Тут приведена полная информация о всех списаниях и начислениях по заказау:
  OperationID - идентификатор финансовой операции у нас в системе;
  Money - сумма операции в рубля;
  Description - текстовое описание операции;
  OperationType - тип операции;
  OperationDate - дата и время выполнения операции.



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