getOrdersList

getOrdersList — выводит список заказов с возможностью фильтрации по статусу и клиенту

Описание

Возвращает список заказов и содержимое заказов в выбранном формате. Один запрос может вернуть не больше 100 заказов. Заказы выводятся упорядоченными по дате в обратном порядке (новые заказы сначала). Чтобы получить больше 100 заказов, можно использовать параметр offset. Для вывода заказов сделанных конкретным клиентом нужно использовать параметр client_id.

Список параметров

count: (integer) количество заказов, которое необходимо вернуть, если задано больше 100, то метод вернет только 100 заказов
offset: (integer) смещение, с какого порядкового номера нужно начать вывод
status_id: (integer) идентификатор статуса
client_id: (integer) идентификатор клиента

Примеры

Пример запроса в формате xml

http://site.ru/api/basket/?method=getOrdersList&key=xxxx&format=xml

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

<result>
    <responce>ok</responce>
    <count>2</count>
    <orders>
        <order ID="508" DT="2017-03-16 12:11:36" FIO="Тест Тестович" EMAIL="demo@rapido.su" CONTACT="Стахановцев 14к1" TEL="+7(905)204-77-51" STATUS="3" SUMM="9690.00" CK="5" DELIVERY="Доставка курьером по СПБ" DELIVERY_PRICE="0" SPOPL="" CLIENT_ID="0" STATUS_STR="Ожидает оплаты">
            <positions>
                <position ITEM_ID="114" ITEM_TP="goods" KOL="1" PRICE="2800.00" ART="" COMM="" COST="2800.00" ZAG="Первоначальный Юпитер глазами современников" />
                <position ITEM_ID="111" ITEM_TP="goods" KOL="2" PRICE="3700.00" ART="" COMM="" COST="7400.00" ZAG="Астероидный радиант: основные моменты" />
            </positions>
        </order>
        <order ID="507" DT="2017-03-16 11:46:42" FIO="Тест Тестович" EMAIL="demo@rapido.su" CONTACT="Стахановцев 14к1" TEL="+7(905)204-77-51" STATUS="4" SUMM="3000.00" CK="0" DELIVERY="Доставка курьером по СПБ" DELIVERY_PRICE="200" SPOPL="" CLIENT_ID="0" STATUS_STR="Оплачено">
            <positions>
                <position ITEM_ID="114" ITEM_TP="goods" KOL="1" PRICE="2800.00" ART="" COMM="" COST="2800.00" ZAG="Первоначальный Юпитер глазами современников" />
            </positions>
        </order>
    </orders>
</result>

Пример запроса в формате json

http://site.ru/api/basket/?method=getOrdersList&key=xxxx

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

{
    "responce": "ok",
    "count": 2,
    "orders": [{
        "ID": "508",
        "DT": "2017-03-16 12:11:36",
        "FIO": "Тест Тестович",
        "EMAIL": "demo@rapido.su",
        "CONTACT": "Стахановцев 14к1",
        "TEL": "+7(905)204-77-51",
        "STATUS": "3",
        "SUMM": "9690.00",
        "CK": "5",
        "DELIVERY": "Доставка курьером по СПБ",
        "DELIVERY_PRICE": "0",
        "SPOPL": "",
        "CLIENT_ID": "0",
        "STATUS_STR": "Ожидает оплаты",
        "positions": [{
            "ITEM_ID": "114",
            "ITEM_TP": "goods",
            "KOL": "1",
            "PRICE": "2800.00",
            "ART": "",
            "COMM": "",
            "COST": "2800.00",
            "ZAG": "Первоначальный Юпитер глазами современников"
        }, {
            "ITEM_ID": "111",
            "ITEM_TP": "goods",
            "KOL": "2",
            "PRICE": "3700.00",
            "ART": "",
            "COMM": "",
            "COST": "7400.00",
            "ZAG": "Астероидный радиант: основные моменты"
        }]
    }, {
        "ID": "507",
        "DT": "2017-03-16 11:46:42",
        "FIO": "Тест Тестович",
        "EMAIL": "demo@rapido.su",
        "CONTACT": "Стахановцев 14к1",
        "TEL": "+7(905)204-77-51",
        "STATUS": "4",
        "SUMM": "3000.00",
        "CK": "0",
        "DELIVERY": "Доставка курьером по СПБ",
        "DELIVERY_PRICE": "200",
        "SPOPL": "",
        "CLIENT_ID": "0",
        "STATUS_STR": "Оплачено",
        "positions": [{
            "ITEM_ID": "114",
            "ITEM_TP": "goods",
            "KOL": "1",
            "PRICE": "2800.00",
            "ART": "",
            "COMM": "",
            "COST": "2800.00",
            "ZAG": "Первоначальный Юпитер глазами современников"
        }]
    }]
}

Смотрите также:

getStatusList — возвращает список статусов, которые могут быть назначены заказам.
sendNotice — отправляет уведомление на почту клиенту. Шаблон уведомления задается в настройках корзины.
setStatus — назначает новый статус заказу
setAdminComment — задает комментарий администратора к заказу

← Вернуться к списку