Описание протокола API

From PonyExpress API Wiki
Jump to: navigation, search

Общее описание

Основной метод API на вход принимает 2 параметра: accessKey – ключ доступа и requestBody – строка XML, описывающая запрос. Данные раздел посвящён второму параметру - строке XML, описывающей запрос.

Типы запросов

Каждый запрос относится к конкретному типу. Тип запроса задаётся в корневом элементе строки Xml в атрибуте xsi:type:

<?xml version="1.0" encoding="utf-8"?>
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xsi:type="OrderRequest">
  ...
</Request>

В таблице ниже представлен список возможных типов запросов.

Тип запроса Сценарий Примечание Примеры
OrderRequest Расчёт стоимости заказа
Создание заказа
Отмена заказа
Получение статуса заказа.
Запрос прямо связанный с заказом с помощью его исходного

номера в информационной системе подателя заказа или
идентификаторов в информационной системе Пони Экспресс

Калькулятор
Заказ от ИМ
Заказ для стандартной доставки
Отмена заказа
Статусы по заказу
WhatIsNewRequest Отслеживание статусов Запрос новых статусов, произошедших с момента последнего запроса WhatIsNewRequest "What is new"
HistoryRequest Отслеживание статусов Запрос изменений в статусах заказов случившихся в течении заданного периода История заказов
PrintRequest Печать этикеток Запрос PDF, содержащего накладные в виде наклеек Печать наклеек
PickupPointsRequest Получение справочных данных Запрос списка ПВЗ Запрос списка ПВЗ
ConsolidationRequest Консолидация отправлений Используется при доставки из дальнего зарубежья в Россию (ТГ) Консолидация домашней авианакладной(HAWB)
Консолидация мастер авианакладной(MAWB)

Описание протокола API

Для загрузки протокола API перейдите по ссылке: Скачать протокол API