Получение списка заказов
1. getorders — получить список заказов
Запрос: GET
Адрес: https://online.bizon365.ru/api/v2/XXXX/orders/getorders, где XXXX - номер проекта
Аргументы:
- skip (по умолчанию = 0)
пропустить указанное число записей - limit (по умолчанию = 100)
ограничить количество записей. Не более 100. - days
заказы в диапазоне указанного количества дней относительно текущего момента. Текущий день всегда включается. Т.е. days = 6 — это получить заказы за сегодня и 6 дней до этого, итого 7 дней. - dateBegin
начальная дата поиска в нестрогом ISO-формате. Пример: dateBegin=2015-02-01T00:00:00 - dateEnd
конечная дата поиска в нестрогом ISO-формате. Пример: dateEnd=2017-05-01T00:00:00 - paid:
При присвоении параметру определенного значения будут выводиться заказы:
не указан или = -1 — все заказы
0 — неоплаченные (исключая частично-оплаченные)
1 — полностью оплаченные.
2 — рекуррентные, начиная со 2-го платежа (оплаченные)
3 — полностью оплаченные, исключая рекуррентные
5 — неоплаченные + частично оплаченные
Пример: paid=1 - выводить только оплаченные заказы. - free=1 — выводить бесплатные заказы.
- search
поисковая строка — в имени, телефоне и e-mail.
Поле days имеет приоритет по отношению к dateBegin/dateEnd.
Если не заданы ни days (или равно нулю), ни dateBegin/dateEnd, то принимается days = 14.
Ответ сервера:
JSON в формате
{
skip: использованное значение skip,
limit: использованное значение limit,
total: общее количество подходящих под запрос данных в базе,
list: [ список заказов ],
dateBegin: "DD.MM.YYYY",
dateEnd: "DD.MM.YYYY,
search: "использованная поисковая строка",
}
Список заказов — это массив объектов следующего формата:
-
_id
номер заказа, например: 100407 -
firstname: "Имя покупателя"
-
lastname: "Фамилия (опционально)",
-
middlename: "Отчество (опционально)",
-
email: "'e-mail покупателя",
-
phone: "+79998887766",
-
goods: "[{"_id":"kvadro5","price":1000,"cnt":1}]"
перечень заказанных товаров, с указанием цены и количества. JSON упакован в строку. -
title: "Перечень названий товаров"
-
amount: 1000,
сумма заказа в выбранной валюте -
currency: "RUR",
валюта заказа. Поддерживается RUR, UAH, EUR, USD -
amount_RUR: 1000,
эквивалентная сумма заказа в рублях, посчитанная по курсу ЦБ в момент оформления заказа. -
gate: "обозначение платежной системы, через которую был оплачен заказ",
-
ip: "127.0.0.1",
-
channel: "id канала",
-
partner: "refid партнера 1-го уровня",
-
partner2: "refid партнера 2-го уровня",
-
comment: "комментарий покупателя к заказу",
-
coupon: "скидочный купон, введенный покупателем",
-
pixel: "id отслеживающего пикселя в системе аналитики",
-
address: "почтовый адрес покупателя (если указывался)",
-
city: "город покупателя, определенный по IP",
-
country_code: "код страницы, определенный по IP",
-
hash: "B9YNHMWxW",
уникальный код защиты для доступа к странице способов оплаты со стороны покупателя -
created: "2017-05-10T22:33:21.290Z",
дата создания заказа -
paid: false,
флаг, оплачен заказ или нет -
partner_already_rewarded: 1,
было ли выплачено вознаграждение партнеру за этот заказ -
appear: "",
обозначение -
referer: "ссылка",
-
utm: { },
метки из отслеживающего пикселя или из партнерского куки - sup — Параметр подписчика (значение Произвольного параметра в URL страницы регистрации)
-
partner_reward: 0,
величина вознаграждения партнеру за этот заказ -
partner_reward_canceled: 0,
отменено ли вознаграждение партнеру по этому заказу -
partner2_reward: 0,
величина вознаграждения партнеру второго уровня -
manager_reward: 0,
вознаграждение ответственного менеджера -
coowners_reward: "{"id_товара":{"id_совладельца":420}}",
вознаграждения совладельцев -
profit_amount: 420,
величина прибыли -
tax: 60
величина налогов
В случае, если заказ является частично оплаченным, в объекте заказа будут присутствовать дополнительные поля:
- partialPaid Число
оплаченная сумма в валюте товара - partialPaid_RUR Число
оплаченная сумма в рублях - payments Массив
массив оплат. Каждая оплата содержит поля:
— date (дата предоплаты),
— amount (сумма в валюте),
— cur (валюта),
— gate (способ оплаты)