Метод getStatus

Возвращает информацию о заказе по идентификатору заявки (id) или идентификатору заказа на платформе Giftery (order_id).

Параметры запроса (data)

В запросе обязательно нужно передать один из двух параметров. Если передать оба параметра, приоритет будет иметь параметр id.

Параметр	Описание
id	Идентификатор заявки. Целое, больше нуля число. Возвращается методом makeOrder.
order_id	Идентификатор заказа (платформа Giftery). Целое, больше нуля число.

Параметры ответа (data)

Параметр	Описание
status	Статус заявки или заказа (ok, error, error_to, pending, executing, cancel, delayed). Описание: ok - заказ успешно обработан; error - обработка заказа завершилась ошибкой; error_to - ошибка при доставке получателю; pending - заказ находится в очереди, обработка начнётся в ближайшее время; executing - заказ обрабатывается в данный момент, обработка закончится в ближайшее время; cancel - заказ был отменён до завершения; delayed - заказ не может быть обработан в ближайшее время, заказ находится в стадии ожидания поступления кодов; после поступления кодов заказ будет обработан.
id	ID заявки (см. метод makeOrder)
order_id	ID заказа (платформа Giftery). Значение может быть null, если заявка ещё не была обработана и по ней не был выпущен сертификат. В тестовом режиме значение будет равно 999999.
product_id	ID продукта (см. метод getProducts)
face	Номинал сертификата (см. метод getProducts)
balance	Текущий баланс для сертификатов с возможность погашения (может быть int или null)
expire_date	Дата окончания действия сертификата (может быть строкой в формате Y-m-d H:i:s или null)
code	Служебный код заказа (см. метод makeOrder)
comment	Служебный комментарий к заказу (см. метод makeOrder)
external_id	Идентификатор во внешней системе. Строка или null. (см. метод makeOrder)
testmode	Флаг выполнения заявки в тестовом режиме.
gift_page_url	Ссылка на страницу получения сертификата. Если ссылка недоступна, возвращается null.
error_code	ID ошибки, произошедшей во время обработки заказа. Передаётся в случае status = error.
error_text	Описание ошибки, произошедшей во время обработки заказа. Передаётся в случае status = error.

Пример

# Получаем значение для подстановки SIG
# SECRET в данном случае - это хранящийся у клиента ключ для подписи запросов к API
$ echo -n 'getStatus{"id":4578412}SECRET' | sha256sum - | awk '{print $1}'

# Используем известный клиенту ID и сгенерированный SIG для выполнения запроса
$ curl 'https://ssl-api.giftery.ru/?cmd=getStatus&id=ID&in=json&out=json&data=%7B%22id%22%3A4578412%7D&sig=SIG'

Результат запроса

{
    "status": "ok",
    "data": {
        "status": "ok",
        "id": 4578412,
        "order_id": 2457845,
        "product_id": 2111,
        "face": 1000,
        "sum": 1000,
        "expire_date": "2029-12-31 23:59:59",
        "code": "API",
        "comment": "",
        "external_id": "123456-1",
        "testmode": 0,
        "gift_page_url": "https://my.giftery.app/gift/new/12457845qA1iO9vV2n"
    }
}

{
  "status": "ok",
  "data": {
    "status": "error",
    "id": 4578413,
    "order_id": 2457846,
    "product_id": 2111,
    "face": 1000,
    "sum": 1000,
    "expire_date": null,
    "code": "API",
    "comment": "",
    "external_id": "123456-1",
    "testmode": 0,
    "gift_page_url": null,
    "error_code": 3701,
    "error_text": "Не указан обязательный параметр data"
  }
}

Распространённые ошибки

Код ошибки	Описание
3602	Необходимо указать один из двух обязательных параметров: id или order_id.
3603	Необходимо проверить правильность указания параметра id. Не удалось найти ничего по переданному значению.
3603	Необходимо проверить правильность указания параметра order_id. Не удалось найти ничего по переданному значению.