Рефсейлс API
Заказы

Получить заказ

GET
/api/v1/orders/{id}

Один заказ с позициями. Ищет по ID Рефсейлс, а с by=externalId по ID из вашей системы. Право: orders:read.

Авторизация

bearerApiKey
headerАвторизацияBearer <ключ>

Ключ API в заголовке Authorization: Bearer rsk_live_…. Ключ создаёт владелец магазина: Настройки → Интеграции → API-ключи.

Параметры пути

id*string

ID заказа в Рефсейлс или, с by=externalId, ID во внешней системе.

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

by?string

По какому ID искать. По умолчанию id.

Value in"id""externalId"

Ответ

Заказ.

application/json
  1. response
data*
curl -X GET "https://example.com/api/v1/orders/string"
{  "data": {    "id": "3f0e6c5a-2b7d-4e21-9a0f-6d1c8b4e7a52",    "externalId": "A-1001",    "createdAt": "2026-09-12T09:41:07.418265+00:00",    "updatedAt": "2026-09-12T14:03:55.418265+00:00",    "status": {      "id": "0b6f2c1e-9a4d-4e7b-8c3f-5d1a2e9b7c60",      "code": "new",      "name": "Новый"    },    "paymentStatus": {      "id": "f5b9d3a1-6c2e-4f8b-a7d0-9e1c3b5f7a42",      "code": "paid",      "name": "Оплачен",      "isPaid": true    },    "totalAmount": 327000,    "discountTotal": 15000,    "promoCode": "OSEN10",    "currency": "RUB",    "customer": {      "name": "Иван Петров",      "phone": "+79000000000",      "email": "customer@example.com"    },    "delivery": {      "type": "СДЭК до пункта выдачи",      "cost": 35000,      "discount": 0,      "includedInTotal": true,      "address": "Москва, ул. Примерная, 1, кв. 1",      "city": "Москва",      "region": "Москва",      "street": "ул. Примерная",      "house": "1",      "flat": "1",      "postalCode": "101000"    },    "source": "api",    "notes": "Позвонить за час до доставки",    "items": [      {        "id": "b91d2f6e-0c4a-4f8e-8d3b-27a5e1c9f604",        "productId": "dcd53ddb-8104-4e48-8cc0-5df1c5a0d1e2",        "externalProductId": "MS-00124",        "name": "Свеча ароматическая «Хвоя», 200 г",        "sku": "CNDL-200-PINE",        "quantity": 2,        "unitPrice": 120000,        "discount": 12000,        "lineTotal": 228000      },      {        "id": "5e8a1b3c-7d2f-4a6e-9c0b-81f4d2e6a9c7",        "productId": "a4c7e2b9-3f1d-4c8a-b6e0-9d2f5a1c7e38",        "externalProductId": "MS-00311",        "name": "Подставка из бетона",        "sku": "HLDR-CONC",        "quantity": 1,        "unitPrice": 67000,        "discount": 3000,        "lineTotal": 64000      }    ]  }}

Список заказов GET

Заказы магазина, по умолчанию новые сверху. Страницы листаются курсором: передайте page.nextCursor в параметр cursor. Для синхронизации запрашивайте order=updatedAt:asc с filter[updatedAt][from]. Суммы в копейках. Право: orders:read.

Получить ссылку на оплату POST

Выдаёт ссылку, по которой покупатель оплатит заказ через подключённый способ оплаты магазина: PayAnyWay или анкету школы ProOnline. Нужно подключение в настройках интеграций. Сумма берётся из заказа в момент запроса. Если сумма заказа изменилась, запросите ссылку заново: старая перестанет открываться. Повторный запрос для того же заказа возвращает действующую ссылку. Оплату подтверждает платёжная система, после этого заказ становится оплаченным. Ищет заказ по ID Рефсейлс, а с by=externalId по ID из вашей системы. Право: orders:write.