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

[POST] Получение списка идентификаторов заказов

Описание запроса

POST /v1/order/search

Запрос позволяет получить список идентификаторов заказов, отвечающих заданным условиям поиска.

Этот запрос может быть использован также для получения идентификаторов платежей, созданных через Softline Payments.

Данные для отправки запроса

Endpoints URL:
- Боевая среда: https://api.ecommerce.softline.com/v1/order/search
- Тестовая среда: https://api.ecommerce.softline.com.demoslweb.com/v1/order/search
Метод: POST
Формат: JSON
Авторизация: с помощью токена

Параметры заголовка

content-type

string

required

MIME-тип данных в теле запроса

Должен быть равен "application/json".

AuthorizationJWT

required

Авторизационный токен

Формат значения: Bearer [token]
Вместо [token] подставьте значение token, полученное в ответ на запрос к Authentication API

Параметры в теле запроса

status

string

Статус заказа

Варианты значений:

not paid - не оплачен
paid - оплачен
deleted - удален

Узнайте подробнее о статусах заказов.

external_id

string

Идентификатор корзины
Используется, если оформлен заказ на продукт с динамическими характеристиками. Этот идентификатор вы получаете в ответ на запрос генерации ссылки на покупку продукта с динамическими характеристиками (buy_link).

Для платежей Softline Payments это идентификатор платежа на вашей стороне

create_date_from

string

Начало периода, в котором был создан заказ
В результате будут найдены заказы, которые отвечают условию: [дата и время создания заказа] ≥ [create_date_from].

Формат: YYYY-MM-DDThh:mm:ss±hh:mm.

create_date_to

string

Окончание периода, в котором был создан заказ
В результате будут найдены заказы, которые отвечают условию: [дата и время создания заказа] ≤ [create_date_to].

Формат: YYYY-MM-DDThh:mm:ss±hh:mm.

pay_date_from

string

Начало периода, в котором был оплачен заказ
В результате будут найдены заказы, которые отвечают условию: [дата и время успешной оплаты заказа] ≥ [pay_date_from].

Формат: YYYY-MM-DDThh:mm:ss±hh:mm.

pay_date_to

string

Окончание периода, в котором был оплачен заказ
В результате будут найдены заказы, которые отвечают условию: [дата и время оплаты заказа] ≤ [pay_date_to].

Формат: YYYY-MM-DDThh:mm:ss±hh:mm.

currency

string

Код валюты заказа

Формат: ISO 4217 alpha-3, 3 символа
Варианты значений см. в справочнике

string

Email покупателя

payment_method

string

Код платежного метода заказа
Варианты значений см. в справочнике.

limit

number

Количество заказов, которое должно быть возвращено в ответе
Если не передано, то в ответе будет возвращено количество заказов по умолчанию. Обратитесь в службу поддержки, если вы хотите изменить это значение.

offset

number

Количество заказов, на которое нужно сдвинуть выдачу результатов

Если не передано или равно 0, то в ответе будут возвращены заказы, начиная с первого найденного.
Если offset равен 10, то в ответе будут возвращены заказы, начиная с 11-ого из числа найденных.

Обратите внимание, все параметры являются необязательными. Если вы делаете запрос без параметров, то в теле запроса должны быть только пустые скобки {}.

Пример запроса

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

{
  "status": "not paid",
  "external_id": "12345",
  "create_date_from": "2022-01-01T00:00:00+00:00",
  "create_date_to": "2022-01-31T00:00:00+00:00",
  "pay_date_from": "2022-01-01T00:00:00+00:00",
  "pay_date_to": "2022-01-31T00:00:00+00:00",
  "currency": "RUB",
  "email": "customer@mail.com",
  "payment_method": "CreditCard",
  "limit": 100,
  "offset": 10
}

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

{}

Ответ на запрос

В ответ на запрос вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.

Положительный ответ

При успешной обработке запроса вы получите код ответа сервера HTTP/1.1 200 OK. В теле ответа будет передан список найденных заказов в формате JSON.

Параметры в теле ответа

count_all

number

required

Количество найденных заказов

limit

number

Количество заказов в ответе

offset

number

Сдвиг. Позиция заказа, со следующей за которой возвращены заказы в ответе.

ids

array [numbers]

Массив идентификаторов найденных заказов/платежей.
Может быть передан пустым, если не найдено заказов, отвечающих условиям поиска. В том числе, если в запросе задан сдвиг (offset) больше доступного числа заказов (count_all).

Пример положительного ответа

{
  "count_all": 155,
  "limit": 5,
  "offset": 5,
  "ids": [
    11111111,
    22222222,
    33333333
  ]
}

Ответ об ошибке

В случае ошибки при обработке запроса вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.

Справочник HTTP-кодов ответа сервера при ошибке

Код ответа сервера	Описание
HTTP/1.1 400 Bad Request	Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.). В теле ответа будет передан дополнительный код ошибки (один или несколько).
HTTP/1.1 401 Unauthorized	Неуспешная аутентификация. В теле ответа будет передан дополнительный код ошибки (один или несколько).
HTTP/1.1 404 Not found	Неверный URL запроса. Проверьте адрес запроса.
HTTP/1.1 500 Request Error	Ошибка на стороне сервера. Повторите запрос позднее или обратитесь в службу поддержки.

Справочник дополнительных кодов ошибок для HTTP 400

Error	Message	Описание
Если хотя бы одна ошибка из списка ниже найдена, то она возвращается в ответе на запрос, остальные ошибки не проверяются.
110	JSON is not valid.	Структура параметров запроса невалидна. Проверьте параметры в теле запроса на соответствие формату JSON.
111	Invalid data format (Content-type).	Неправильный заголовок запроса. Content-type должен быть равен application/json.
15000	Unable to identify your configuration for accessing this API. Please contact technical support.	При обработке не смогли однозначно определить настройки вашего аккаунта. Обратитесь в службу поддержки.
Если хотя бы одна ошибка из списка ниже найдена, то проверка запроса не прерывается. В ответе может быть возвращено несколько ошибок.
15010	Invalid field value: [наименование параметра]	Запрос не валиден, например, не заполнен обязательный параметр, передано неверное название параметра, тип или формат значения параметра неверны. В том числе ошибка будет возвращена, если в параметре передано null, и этот вариант значения не указан как допустимый.

Справочник дополнительных кодов ошибок для HTTP 401

Справочник этих ошибок одинаковый для всех API, которые используют авторизацию по токену.

Параметры в теле ответа

errors

array [objects]

required

Список ошибок

errors / [error object]

error

number

required

Код ошибки

errors / [error object]

message

string

Описание ошибки

Пример ответа об ошибке

{
  "errors": [{
      "error": 15010,
      "message": "Invalid field value: email"
    }
  ]
}