/v1/orders

Запрос на создание заказа. Возвращает ссылку на оплату заказа.

Request

POST

https://pay.yandex.uz/api/merchant/v1/orders

Production

POST

https://sandbox.pay.yandex.uz/api/merchant/v1/orders

Sandbox

Body

application/json
{
  "availablePaymentMethods": null,
  "billingPhone": "example",
  "cart": {
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "features": null,
        "productId": "example",
        "quantity": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "unitPrice": "123.45"
      }
    ],
    "total": {
      "amount": "123.45"
    }
  },
  "currencyCode": "RUB",
  "extensions": null,
  "isPrepayment": true,
  "metadata": "example",
  "orderId": "example",
  "orderSource": "null",
  "preferredPaymentMethod": "FULLPAYMENT",
  "publicConstructor": "example",
  "purpose": "example",
  "redirectUrls": {
    "onAbort": "example",
    "onError": "example",
    "onSuccess": "example"
  },
  "risk": {
    "billingPhone": "example",
    "customerAggregates": {
      "amountFirstSuccessfulOrder": "123.45",
      "amountLatestSuccessfulOrder": "123.45",
      "cookie": "example",
      "daysSinceLastPasswordReset": 0,
      "failedLoginAttemptsOneDay": 0,
      "failedLoginAttemptsSevenDays": 0,
      "firstSuccessfulOrderDate": "2025-01-01",
      "historicalCookieLogin": true,
      "historicalDeviceLogin": true,
      "lastPasswordResetDate": "2025-01-01",
      "latestSuccessfulOrderLastYearDate": "2025-01-01",
      "previousSuccessfulOrdersAtSameAddress": true,
      "redemptionRateLastHalfYear": "123.45",
      "registrationDate": "2025-01-01"
    },
    "deviceId": "example",
    "isExpressShipping": true,
    "merchantMcc": "example",
    "merchantName": "example",
    "merchantOfflinePosLegalAddress": "example",
    "merchantTaxRefNumber": "example",
    "periodCheckAggregates": {
      "successfulOrdersCountNineMonths": 0,
      "successfulOrdersCountOneMonth": 0,
      "successfulOrdersCountSixMonths": 0,
      "successfulOrdersCountThreeMonths": 0,
      "successfulOrdersCountTwelveMonths": 0,
      "totalAmountSuccessfulOrdersNineMonths": "123.45",
      "totalAmountSuccessfulOrdersOneMonth": "123.45",
      "totalAmountSuccessfulOrdersSixMonths": "123.45",
      "totalAmountSuccessfulOrdersThreeMonths": "123.45",
      "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
    },
    "qrType": "static",
    "qrcId": "example",
    "shippingAddress": "example",
    "shippingPhone": "example",
    "shippingType": "COURIER"
  },
  "ttl": 1800
}

Name

Description

cart
All of 1 type

  • Type: RenderedCart

    Примечание

    Стоимость доставки передавайте в items как отдельный товар.

    Example
    {
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45"
  }
}

Корзина

Example
{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": null,
      "productId": "example",
      "quantity": null,
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45"
  }
}

currencyCode

Type: string

Трехбуквенный код валюты заказа (ISO 4217)

Enum: RUB, UZS

Max length: 2048

orderId

Type: string

Идентификатор заказа на стороне продавца (должен быть уникальным). Дальнейшее взаимодействие по заявке на оплату будет осуществляться с использованием этого идентификатора. Также данный идентификатор будет использоваться в сверках

Max length: 2048

Example: example

availablePaymentMethods

Type: string[]

Методы оплаты, которые будут доступны покупателю в платежной форме Yandex Split.

Возможные варианты:

  • ["SPLIT"] — только Сплит;

Default: null

Min items: 1

Example
[
  "CARD"
]

billingPhone

Type: string

Номер телефона клиента.

Используется для упрощения авторизации, а также может увеличить вероятность одобрения по Сплиту.

Для номера телефона предлагаем использовать формат +998123456789 или 998123456789. В строке допустимо наличие других символов, однако все символы, кроме цифр, игнорируются.

Например, такие переданные значения 998123456789, +998123456789, +998 (12) 345-67-89 будут обрабатываться как 998123456789.

Max length: 2048

Example: example

extensions
All of 1 type

  • Type: OrderExtensions

    Example
    {
  "billingReport": {
    "branchId": "null",
    "managerId": "null"
  },
  "paymentData": {
    "saleToken": "example"
  },
  "qrData": {
    "token": "example"
  },
  "smsOffer": {
    "phone": "example"
  }
}

Дополнительные параметры для оформления офлайн-заказа

Default: null

isPrepayment

Type: boolean

Проводить ли заказ по флоу «отложенной оплаты».

Если параметр установлен в true, то заказ будет оформляться как заказ с отложенной оплатой.

metadata

Type: string

Произвольные данные по заказу для внутреннего использования

Max length: 2048

Example: example

orderSource

Type: string

Поверхность на которой инициализировали создание заказа

Необходимо для последующей аналитики

WEBSITE: Кнопка размещена на сайте. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя на сайте

APP: Кнопка размещена в мобильном приложении. Ссылка на оплату сформировалась после действий (нажатия кнопки) пользователя в приложении

CRM: Ссылка на оплату сформирована менеджером в CRM или другой админке

CASH_REGISTER: Ссылка на оплату сформирована для отображения на оффлайн-кассе

CMS_PLUGIN: Ссылка на оплату сформирована в плагине для CMS

TV: Ссылка на оплату сформирована для отображения на ТВ-платформе

Default: null

Enum: WEBSITE, APP, CRM, CASH_REGISTER, CMS_PLUGIN

preferredPaymentMethod

Type: string

Предпочтительный метод оплаты.

Переданный метод будет автоматически выбран на форме оплаты, если это не противоречит доступным методам оплаты в availablePaymentMethods.

Enum: FULLPAYMENT, SPLIT

publicConstructor

Type: string

Конструктор предвыбранного плана для оплаты в Сплит.

Доступно только по согласованию

Example: example

purpose

Type: string

Назначение платежа

Max length: 1000

Example: example

redirectUrls
All of 1 type

  • Type: MerchantRedirectUrls

    Example
    {
  "onAbort": "example",
  "onError": "example",
  "onSuccess": "example"
}

Ссылки для переадресации пользователя с формы оплаты. Обязательно для онлайн-магазинов.

Example
{
  "onAbort": "example",
  "onError": "example",
  "onSuccess": "example"
}

risk
All of 1 type

  • Type: MerchantRiskInfo

    Example
    {
  "billingPhone": "example",
  "customerAggregates": {
    "amountFirstSuccessfulOrder": "123.45",
    "amountLatestSuccessfulOrder": "123.45",
    "cookie": "example",
    "daysSinceLastPasswordReset": 0,
    "failedLoginAttemptsOneDay": 0,
    "failedLoginAttemptsSevenDays": 0,
    "firstSuccessfulOrderDate": "2025-01-01",
    "historicalCookieLogin": true,
    "historicalDeviceLogin": true,
    "lastPasswordResetDate": "2025-01-01",
    "latestSuccessfulOrderLastYearDate": "2025-01-01",
    "previousSuccessfulOrdersAtSameAddress": true,
    "redemptionRateLastHalfYear": "123.45",
    "registrationDate": "2025-01-01"
  },
  "deviceId": "example",
  "isExpressShipping": true,
  "merchantMcc": "example",
  "merchantName": "example",
  "merchantOfflinePosLegalAddress": "example",
  "merchantTaxRefNumber": "example",
  "periodCheckAggregates": {
    "successfulOrdersCountNineMonths": 0,
    "successfulOrdersCountOneMonth": 0,
    "successfulOrdersCountSixMonths": 0,
    "successfulOrdersCountThreeMonths": 0,
    "successfulOrdersCountTwelveMonths": 0,
    "totalAmountSuccessfulOrdersNineMonths": "123.45",
    "totalAmountSuccessfulOrdersOneMonth": "123.45",
    "totalAmountSuccessfulOrdersSixMonths": "123.45",
    "totalAmountSuccessfulOrdersThreeMonths": "123.45",
    "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
  },
  "qrType": "static",
  "qrcId": "example",
  "shippingAddress": "example",
  "shippingPhone": "example",
  "shippingType": "COURIER"
}

Дополнительная информация, наличие которой может увеличить вероятность одобрения по Сплиту. Доступно в полной мере только для онлайн-магазинов.

Example
{
  "billingPhone": "example",
  "customerAggregates": {
    "amountFirstSuccessfulOrder": "123.45",
    "amountLatestSuccessfulOrder": "123.45",
    "cookie": "example",
    "daysSinceLastPasswordReset": 0,
    "failedLoginAttemptsOneDay": 0,
    "failedLoginAttemptsSevenDays": 0,
    "firstSuccessfulOrderDate": "2025-01-01",
    "historicalCookieLogin": true,
    "historicalDeviceLogin": true,
    "lastPasswordResetDate": "2025-01-01",
    "latestSuccessfulOrderLastYearDate": "2025-01-01",
    "previousSuccessfulOrdersAtSameAddress": true,
    "redemptionRateLastHalfYear": "123.45",
    "registrationDate": "2025-01-01"
  },
  "deviceId": "example",
  "isExpressShipping": true,
  "merchantMcc": "example",
  "merchantName": "example",
  "merchantOfflinePosLegalAddress": "example",
  "merchantTaxRefNumber": "example",
  "periodCheckAggregates": {
    "successfulOrdersCountNineMonths": 0,
    "successfulOrdersCountOneMonth": 0,
    "successfulOrdersCountSixMonths": 0,
    "successfulOrdersCountThreeMonths": 0,
    "successfulOrdersCountTwelveMonths": 0,
    "totalAmountSuccessfulOrdersNineMonths": "123.45",
    "totalAmountSuccessfulOrdersOneMonth": "123.45",
    "totalAmountSuccessfulOrdersSixMonths": "123.45",
    "totalAmountSuccessfulOrdersThreeMonths": "123.45",
    "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
  },
  "qrType": "static",
  "qrcId": "example",
  "shippingAddress": "example",
  "shippingPhone": "example",
  "shippingType": "COURIER"
}

ttl

Type: integer

Параметр определяет время, в течение которого пользователь может воспользоваться ссылкой на форму оплаты заказа.

По истечении времени пользователь будет видеть сообщение "Вышло время оплаты".

Если пользователь воспользовался ссылкой до истечения времени, то на завершение оплаты отводится дополнительно 15 минут. Если по истечении дополнительного времени оплата не произошла, заказ считается не оплаченным окончательно.

Это отражается в изменении статуса заказа Order.paymentStatus на значение FAILED. Также выполняется отправка уведомления об изменении статуса заказа. Если продавец бронировал товар, то после изменения статуса заказ можно отменить.

Время жизни (сек): 180 <= ttl <= 604800

Время жизни (при создании ссылки в личном кабинете, сек): 86400

Default: 1800

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

Недоступно в Узбекистане.

Default: false

tariffModifier

Type: string

Модификатор тарифа для расчета комиссии. Определяет, какой тариф будет применяться при расчете комиссии за обработку позиции в корзине.

Enum: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, null

Example: VERY_LOW
Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

ItemQuantity

Name

Description

count

Type: string<double>

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

Example: 123.45

available

Type: string<double>

Максимально доступное количество товара

Example: 123.45
Example
{
  "available": "123.45",
  "count": "123.45"
}

RenderedCartItem

Name

Description

productId

Type: string

ID товара в системе продавца. В параметрах запроса каждый идентификатор товара productId должен быть уникальным

Max length: 2048

Example: example

quantity
All of 1 type

  • Type: ItemQuantity

    Example
    {
  "available": "123.45",
  "count": "123.45"
}

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

Example
{
  "available": "123.45",
  "count": "123.45"
}

title

Type: string

Наименование товара

Max length: 2048

Example: example

total

Type: string<double>

Суммарная цена за позицию с учетом скидок на позицию

Example: 123.45

description

Type: string

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

Max length: 2048

Example: example

discountedUnitPrice

Type: string<double>

Цена за единицу товара с учетом скидок на позицию

Example: 123.45

features
All of 1 type

  • Type: CartItemFeatures

    Example
    {
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

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

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

skuId

Type: string

Уникальный ID, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа.

Max length: 2048

Example: example

subtotal

Type: string<double>

Суммарная цена за позицию без учета скидок

Example: 123.45

unitPrice

Type: string<double>

Полная цена за единицу товара без учета скидки

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Стоимость корзины с учетом всех скидок.

Example: 123.45
Example
{
  "amount": "123.45"
}

RenderedCart

Примечание

Стоимость доставки передавайте в items как отдельный товар.

Name

Description

items

Type: RenderedCartItem[]

Список товаров в корзине.

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    },
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total
All of 1 type

  • Type: CartTotal

    Example
    {
  "amount": "123.45"
}

Итоговая информация о стоимости заказа.

Example
{
  "amount": "123.45"
}

externalId

Type: string

Идентификатор корзины на стороне продавца.

Max length: 2048

Example: example
Example
{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45"
  }
}

BillingReport

Name

Description

branchId

Type: string

Обязательное поле только для офлайн-магазинов. Идентификатор точки продаж

Default: null

Max length: 2048

managerId

Type: string

Обязательное поле только для офлайн-магазинов. Идентификатор менеджера

Default: null

Max length: 2048
Example
{
  "branchId": "null",
  "managerId": "null"
}

PaymentData

Name

Description

saleToken

Type: string

Уникальный id, генерируемый кассой для каждой операции оплаты

Max length: 2048

Example: example
Example
{
  "saleToken": "example"
}

QRData

Name

Description

token

Type: string

QR токен

Max length: 2048

Example: example
Example
{
  "token": "example"
}

SMSOffer

Name

Description

phone

Type: string

Номер телефона клиента (пример +998123456789) для СМС-информирования. Только для офлайн-магазинов.

Max length: 2048

Pattern: ^\+\d+$

Example: example
Example
{
  "phone": "example"
}

OrderExtensions

Name

Description

billingReport
All of 1 type

  • Type: BillingReport

    Example
    {
  "branchId": "null",
  "managerId": "null"
}

Информация о месте и авторе оформления заказа.

Example
{
  "branchId": "null",
  "managerId": "null"
}

paymentData
All of 1 type

Дополнительные параметры платежа.

Example
{
  "saleToken": "example"
}

qrData
All of 1 type

  • Type: QRData

    Example
    {
  "token": "example"
}

Дополнительные параметры для отправки ссылки на оплату с использованием QR.

Example
{
  "token": "example"
}

smsOffer
All of 1 type

  • Type: SMSOffer

    Example
    {
  "phone": "example"
}

Дополнительные параметры для отправки ссылки на оплату с использованием SMS.

Обязательное поле только для офлайн-магазинов.

Example
{
  "phone": "example"
}
Example
{
  "billingReport": {
    "branchId": "null",
    "managerId": "null"
  },
  "paymentData": {
    "saleToken": "example"
  },
  "qrData": {
    "token": "example"
  },
  "smsOffer": {
    "phone": "example"
  }
}

MerchantRedirectUrls

Name

Description

onError

Type: string

Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае возникновения ошибки во время оплаты, или если срок ссылки на оплату истек.

Max length: 2048

Example: example

onSuccess

Type: string

Обязательное поле только для онлайн-магазинов. Ссылка для переадресации пользователя в случае успешной оплаты.

Max length: 2048

Example: example

onAbort

Type: string

Ссылка для переадресации пользователя в случае отмены процесса оплаты. Отмену оплаты осуществляет пользователь на форме для оплаты.

Max length: 2048

Example: example
Example
{
  "onAbort": "example",
  "onError": "example",
  "onSuccess": "example"
}

CustomerAggregates

Name

Description

amountFirstSuccessfulOrder

Type: string<double>

Сумма первого успешного заказа

Example: 123.45

amountLatestSuccessfulOrder

Type: string<double>

Сумма последнего успешного заказа

Example: 123.45

cookie

Type: string

Куки

Max length: 2048

Example: example

daysSinceLastPasswordReset

Type: integer

Количество дней с момента последнего сброса пароля

failedLoginAttemptsOneDay

Type: integer

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

failedLoginAttemptsSevenDays

Type: integer

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

firstSuccessfulOrderDate

Type: string<date>

Дата первого успешного заказа в истории

Example: 2025-01-01

historicalCookieLogin

Type: boolean

Вход с сохраненной куки (ранее уже оплачивал заказ)

historicalDeviceLogin

Type: boolean

Вход с сохраненного устройства (ранее уже оплачивал заказ)

lastPasswordResetDate

Type: string<date>

Дата последнего сброса пароля

Example: 2025-01-01

latestSuccessfulOrderLastYearDate

Type: string<date>

Дата последнего успешного заказа за последний год

Example: 2025-01-01

previousSuccessfulOrdersAtSameAddress

Type: boolean

Был ли у пользователя успешный заказ по текущему адресу ранее

redemptionRateLastHalfYear

Type: string<double>

Процент выкупа за последние полгода

Example: 123.45

registrationDate

Type: string<date>

Дата регистрации на сайте продавца

Example: 2025-01-01
Example
{
  "amountFirstSuccessfulOrder": "123.45",
  "amountLatestSuccessfulOrder": "123.45",
  "cookie": "example",
  "daysSinceLastPasswordReset": 0,
  "failedLoginAttemptsOneDay": 0,
  "failedLoginAttemptsSevenDays": 0,
  "firstSuccessfulOrderDate": "2025-01-01",
  "historicalCookieLogin": true,
  "historicalDeviceLogin": true,
  "lastPasswordResetDate": "2025-01-01",
  "latestSuccessfulOrderLastYearDate": "2025-01-01",
  "previousSuccessfulOrdersAtSameAddress": true,
  "redemptionRateLastHalfYear": "123.45",
  "registrationDate": "2025-01-01"
}

PeriodCheckAggregates

Name

Description

successfulOrdersCountNineMonths

Type: integer

Количество успешных заказов за последние 9 месяцев

successfulOrdersCountOneMonth

Type: integer

Количество успешных заказов за последний месяц

successfulOrdersCountSixMonths

Type: integer

Количество успешных заказов за последние 6 месяцев

successfulOrdersCountThreeMonths

Type: integer

Количество успешных заказов за последние 3 месяца

successfulOrdersCountTwelveMonths

Type: integer

Количество успешных заказов за последние 12 месяцев

totalAmountSuccessfulOrdersNineMonths

Type: string<double>

Сумма успешных заказов за последние 9 месяцев

Example: 123.45

totalAmountSuccessfulOrdersOneMonth

Type: string<double>

Сумма успешных заказов за последний месяц

Example: 123.45

totalAmountSuccessfulOrdersSixMonths

Type: string<double>

Сумма успешных заказов за последние 6 месяцев

Example: 123.45

totalAmountSuccessfulOrdersThreeMonths

Type: string<double>

Сумма успешных заказов за последние 3 месяца

Example: 123.45

totalAmountSuccessfulOrdersTwelveMonths

Type: string<double>

Сумма успешных заказов за последние 12 месяцев

Example: 123.45
Example
{
  "successfulOrdersCountNineMonths": 0,
  "successfulOrdersCountOneMonth": 0,
  "successfulOrdersCountSixMonths": 0,
  "successfulOrdersCountThreeMonths": 0,
  "successfulOrdersCountTwelveMonths": 0,
  "totalAmountSuccessfulOrdersNineMonths": "123.45",
  "totalAmountSuccessfulOrdersOneMonth": "123.45",
  "totalAmountSuccessfulOrdersSixMonths": "123.45",
  "totalAmountSuccessfulOrdersThreeMonths": "123.45",
  "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
}

MerchantRiskInfo

Name

Description

billingPhone

Type: string

DEPRECATED Номер телефона клиента.
Cледует использовать одноименное поле на уровень выше.

Max length: 2048

Example: example

customerAggregates
All of 1 type

  • Type: CustomerAggregates

    Example
    {
  "amountFirstSuccessfulOrder": "123.45",
  "amountLatestSuccessfulOrder": "123.45",
  "cookie": "example",
  "daysSinceLastPasswordReset": 0,
  "failedLoginAttemptsOneDay": 0,
  "failedLoginAttemptsSevenDays": 0,
  "firstSuccessfulOrderDate": "2025-01-01",
  "historicalCookieLogin": true,
  "historicalDeviceLogin": true,
  "lastPasswordResetDate": "2025-01-01",
  "latestSuccessfulOrderLastYearDate": "2025-01-01",
  "previousSuccessfulOrdersAtSameAddress": true,
  "redemptionRateLastHalfYear": "123.45",
  "registrationDate": "2025-01-01"
}

Агрегированные данные о клиенте

Example
{
  "amountFirstSuccessfulOrder": "123.45",
  "amountLatestSuccessfulOrder": "123.45",
  "cookie": "example",
  "daysSinceLastPasswordReset": 0,
  "failedLoginAttemptsOneDay": 0,
  "failedLoginAttemptsSevenDays": 0,
  "firstSuccessfulOrderDate": "2025-01-01",
  "historicalCookieLogin": true,
  "historicalDeviceLogin": true,
  "lastPasswordResetDate": "2025-01-01",
  "latestSuccessfulOrderLastYearDate": "2025-01-01",
  "previousSuccessfulOrdersAtSameAddress": true,
  "redemptionRateLastHalfYear": "123.45",
  "registrationDate": "2025-01-01"
}

deviceId

Type: string

Идентификатор устройства клиента (device_id/gaid/idfa/ifv)

Max length: 2048

Example: example

isExpressShipping

Type: boolean

Признак экспресс-доставки

merchantMcc

Type: string

MCC мерчанта

Max length: 2048

Example: example

merchantName

Type: string

Название мерчанта

Max length: 2048

Example: example

merchantOfflinePosLegalAddress

Type: string

Юридический адрес оффлайн точки

Max length: 2048

Example: example

merchantTaxRefNumber

Type: string

Налоговый номер мерчанта

Max length: 2048

Example: example

periodCheckAggregates
All of 1 type

  • Type: PeriodCheckAggregates

    Example
    {
  "successfulOrdersCountNineMonths": 0,
  "successfulOrdersCountOneMonth": 0,
  "successfulOrdersCountSixMonths": 0,
  "successfulOrdersCountThreeMonths": 0,
  "successfulOrdersCountTwelveMonths": 0,
  "totalAmountSuccessfulOrdersNineMonths": "123.45",
  "totalAmountSuccessfulOrdersOneMonth": "123.45",
  "totalAmountSuccessfulOrdersSixMonths": "123.45",
  "totalAmountSuccessfulOrdersThreeMonths": "123.45",
  "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
}

Агрегаты по чекам за различные периоды

Example
{
  "successfulOrdersCountNineMonths": 0,
  "successfulOrdersCountOneMonth": 0,
  "successfulOrdersCountSixMonths": 0,
  "successfulOrdersCountThreeMonths": 0,
  "successfulOrdersCountTwelveMonths": 0,
  "totalAmountSuccessfulOrdersNineMonths": "123.45",
  "totalAmountSuccessfulOrdersOneMonth": "123.45",
  "totalAmountSuccessfulOrdersSixMonths": "123.45",
  "totalAmountSuccessfulOrdersThreeMonths": "123.45",
  "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
}

qrcId

Type: string

ID QR-кода

Max length: 2048

Example: example

qrType

Type: string

Тип QR-кода

Enum: static, dynamic, null

Example: static

shippingAddress

Type: string

Адрес доставки. Если выбран способ получения «самовывоз» (PICKUP), то нужно указать адрес пункта выдачи.

Max length: 2048

Example: example

shippingPhone

Type: string

Номер телефона получателя (пример +998123456789)

Max length: 2048

Example: example

shippingType

Type: string

Способ получения заказа

Enum: COURIER, PICKUP, null

Example: COURIER
Example
{
  "billingPhone": "example",
  "customerAggregates": {
    "amountFirstSuccessfulOrder": "123.45",
    "amountLatestSuccessfulOrder": "123.45",
    "cookie": "example",
    "daysSinceLastPasswordReset": 0,
    "failedLoginAttemptsOneDay": 0,
    "failedLoginAttemptsSevenDays": 0,
    "firstSuccessfulOrderDate": "2025-01-01",
    "historicalCookieLogin": true,
    "historicalDeviceLogin": true,
    "lastPasswordResetDate": "2025-01-01",
    "latestSuccessfulOrderLastYearDate": "2025-01-01",
    "previousSuccessfulOrdersAtSameAddress": true,
    "redemptionRateLastHalfYear": "123.45",
    "registrationDate": "2025-01-01"
  },
  "deviceId": "example",
  "isExpressShipping": true,
  "merchantMcc": "example",
  "merchantName": "example",
  "merchantOfflinePosLegalAddress": "example",
  "merchantTaxRefNumber": "example",
  "periodCheckAggregates": {
    "successfulOrdersCountNineMonths": 0,
    "successfulOrdersCountOneMonth": 0,
    "successfulOrdersCountSixMonths": 0,
    "successfulOrdersCountThreeMonths": 0,
    "successfulOrdersCountTwelveMonths": 0,
    "totalAmountSuccessfulOrdersNineMonths": "123.45",
    "totalAmountSuccessfulOrdersOneMonth": "123.45",
    "totalAmountSuccessfulOrdersSixMonths": "123.45",
    "totalAmountSuccessfulOrdersThreeMonths": "123.45",
    "totalAmountSuccessfulOrdersTwelveMonths": "123.45"
  },
  "qrType": "static",
  "qrcId": "example",
  "shippingAddress": "example",
  "shippingPhone": "example",
  "shippingType": "COURIER"
}

Responses

200 OK

Body

application/json
{
  "code": 200,
  "data": {
    "paymentUrl": "example"
  },
  "status": "success"
}

Name

Description

data

Type: CreateOrderResponseData

Example
{
  "paymentUrl": "example"
}

code

Type: unknown

Default: 200

status

Type: string

Default: success

Const: success

RenderedCartItem

Name

Description

productId

Type: string

ID товара в системе продавца. В параметрах запроса каждый идентификатор товара productId должен быть уникальным

Max length: 2048

Example: example

quantity
All of 1 type

  • Type: ItemQuantity

    Example
    {
  "available": "123.45",
  "count": "123.45"
}

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

Example
{
  "available": "123.45",
  "count": "123.45"
}

title

Type: string

Наименование товара

Max length: 2048

Example: example

total

Type: string<double>

Суммарная цена за позицию с учетом скидок на позицию

Example: 123.45

description

Type: string

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

Max length: 2048

Example: example

discountedUnitPrice

Type: string<double>

Цена за единицу товара с учетом скидок на позицию

Example: 123.45

features
All of 1 type

  • Type: CartItemFeatures

    Example
    {
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

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

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

pointsAmount

Type: string<double>

Недоступно в Узбекистане.

Example: 123.45

skuId

Type: string

Уникальный ID, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа.

Max length: 2048

Example: example

subtotal

Type: string<double>

Суммарная цена за позицию без учета скидок

Example: 123.45

unitPrice

Type: string<double>

Полная цена за единицу товара без учета скидки

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "pointsAmount": "123.45",
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Стоимость корзины с учетом всех скидок.

Example: 123.45

pointsAmount

Type: string<double>

Недоступно в Узбекистане.

Example: 123.45
Example
{
  "amount": "123.45",
  "pointsAmount": "123.45"
}

RenderedCart

Примечание

Стоимость доставки передавайте в items как отдельный товар.

Name

Description

items

Type: RenderedCartItem[]

Список товаров в корзине.

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    },
    "pointsAmount": "123.45",
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "unitPrice": "123.45"
  }
]

total
All of 1 type

  • Type: CartTotal

    Example
    {
  "amount": "123.45",
  "pointsAmount": "123.45"
}

Итоговая информация о стоимости заказа.

Example
{
  "amount": "123.45",
  "pointsAmount": "123.45"
}

externalId

Type: string

Идентификатор корзины на стороне продавца.

Max length: 2048

Example: example
Example
{
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "unitPrice": "123.45"
    }
  ],
  "total": {
    "amount": "123.45",
    "pointsAmount": "123.45"
  }
}

CreateOrderResponseData

Name

Description

paymentUrl

Type: string

Ссылка на оплату заказа

Max length: 2048

Example: example
Example
{
  "paymentUrl": "example"
}

No longer supported, please use an alternative and newer version.

Предыдущая
Overview
Следующая
/v1/orders/{order_id}