Заказы

Главная   →   Справка   →   API

Получение списка заказов

Запрос в формате CURL

http://example.ru/api/orders — запрос списка объектов. Поддерживаются методы GET, POST, PUT, DELETE.

Переменные в запросе

  • start — начинать с указанной позиции, по-умолчанию 0;
  • limit — ограничение вывода, по-умолчанию 100;
  • curl --user admin:API_KEY --header 'Content-Type: application/json' -X GET 'http://www.example.ru/adm/api/orders?start=0&limit=10'

Параметры для фильтрации заказов

  • date_from - дата в формате "DD-MM-YYYY HH:MM:SS";
  • date_to - дата в формате "DD-MM-YYYY HH:MM:SS";
  • fio - подстрока для имени покупателя;
  • address - подстрока для почтового адреса покупателя;
  • email - подстрока для электронного адреса покупателя;
  • phone - подстрока для номера телефона покупателя;
  • summ_from - все начиная с суммы заказа;
  • summ_to - все до суммы заказа;
  • pay_status - статус оплаты;
    • S - не оплачен
    • HP - оплачен частично
    • FP - полностью оплачен
  • color - может содержать следующие идентификаторы цвета заказа:
    • yellow
    • red
    • orange
    • pink
    • green
    • purple
    • blue
  • status - может содержать следущие статусы заказа:
    • Пустая строка - Нет статуса
    • U - Заказ оформляется посетителем
    • A - Заказ принят
    • F - Заказ отменен
    • N - Заказ подтвержден
    • P - Заказ комплектуется
    • Z - Задержка
    • S - Готов к отправке
    • M - В пункте самовывоза
    • O - Отправлен
    • V - Вопрос 
    • R - Возврат (самовывоз)
    • K - Возврат (курьерский)
    • C - Доставлен
    • G - Оформляется
    • Q - Запросить отзыв
  • product - идентификатор товара в заказе, выборка заказов содержащих именно этот товар;
  • master_oid - идентификатор покупателя в системе, выдается каждому зарегистрированному пользователю. 6 - идентификатор гостя.

Пример использования с клиентом API:

$ApiClient = new DiCMSApiClient(
    array(
        'login' => 'admin',
        'api_key' => 'API_KEY',
        'api_url' => 'http://www.example.ru/adm/api/'
    )
);
$folders = $ApiClient->get("orders", array());

Ответ сервера

  • total — общее количество заказов
Array
(
    [orders] => Array
        (
            [0] => stdClass Object
                (
                    [order_id] => 768
                    [phone] => 74955458397
                    [email] => 
                    [address] => 
                    [comment] => 
                    [fio] => 
                    [fields] => a:4:{s:8:"delivery";a:3:{s:5:"value";N;s:4:"name";s:8:"delivery";s:6:"runame";s:23:"Тип доставки";}s:6:"date_o";a:3:{s:5:"value";N;s:4:"name";s:6:"date_o";s:6:"runame";s:25:"Дата поставки";}s:9:"postindex";a:3:{s:5:"value";s:0:"";s:4:"name";s:9:"postindex";s:6:"runame";s:12:"Индекс";}s:8:"org_name";a:3:{s:5:"value";N;s:4:"name";s:8:"org_name";s:6:"runame";s:39:"Название организации";}}
                    [status] => A
                    [pay_status] => S
                    [currency] => RUB
                    [pay_method] => INVOICE
                    [summ] => 10
                    [count] => 3
                    [paid] => 0
                    [discount] => 
                    [delivery] => 
                    [delivery_id] => 0
                    [delivery_price] => 0
                    [weight] => 1400
                    [master_oid] => 3
                    [views] => 1
                    [user_unique_key] => 09e87d6ced9f6827f2507b760bd123ad
                    [color] => 
                    [users] => 
                    [created] => 02.06.2016
                    [updated] => 2016-06-20 13:32:57
                    [time] => 16:21
                    [hash] => 05bbc1af6b4ab683232b7e6e0b48289a
                )

        )

    [total] => 12
)

Получение/изменение данных заказа

Запрос в формате CURL

http://example.ru/api/orders/order_id — запрос информации о заказе. Поддерживаются методы GET, POST, PUT, DELETE.

Переменные в запросе

  • order_id — идентификатор объекта, логин пользователя или емейл пользователя.
  • curl --user admin:API_KEY --header 'Content-Type: application/json' -X GET 'http://www.example.ru/adm/api/orders/768'

Пример использования с клиентом API:

$ApiClient = new DiCMSApiClient(
    array(
        'login' => 'admin',
        'api_key' => 'API_KEY',
        'api_url' => 'http://www.example.ru/adm/api/'
    )
);
$user = $ApiClient->get("orders/768", array());

Ответ сервера

  • oid — до символа _ идентификатор объекта в системе, после символа _ хэш выбранных спецификаций.
Array
(
    [ordercontent] => Array
        (
            [0] => stdClass Object
                (
                    [oid] => 1116_762041269
                    [code] => 7118-6090-8785-1724
                    [name] => Красный помидор
                    [count] => 2
                    [price] => 0
                    [total] => 0
                    [articul] => ПОМИК-КР
                    [discount] => 99%
                    [oldprice] => 60
                    [oldtotal] => 120
                }
            [1] => stdClass Object
                (
                    [oid] => 1313_2180272168
                    [code] => 6790-2497-1559-7477
                    [name] => Брюки
                    [count] => 1
                    [price] => 10
                    [total] => 10
                    [articul] => 
                    [discount] => 99%
                    [oldprice] => 1000
                    [oldtotal] => 1000
             )
        )
    [success] => 1
) 

Теперь, вы знаете, что делать


— или посмотреть пример магазина

Создание интернет-магазина