/v1/orders/{order_id}ㅤ

Запрос на получение деталей заказа.

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

Request

GET

https://pay.yandex.ru/api/merchant/v1/orders/{order_id}

Production

GET

https://sandbox.pay.yandex.ru/api/merchant/v1/orders/{order_id}

Sandbox

Path parameters

Name

Description

order_id

Type: string

Уникальный идентификатор заказа на стороне продавца, который был передан в /orders при создании заказа.

Max length: 2048

Example: ``

Responses

200 OK

Body

application/json
{
  "code": 200,
  "data": {
    "delivery": {
      "actualPrice": "123.45",
      "created": "2025-01-01T00:00:00Z",
      "price": "123.45",
      "status": "NEW",
      "updated": "2025-01-01T00:00:00Z"
    },
    "operations": [
      {
        "amount": "123.45",
        "approvalCode": "example",
        "created": "2025-01-01T00:00:00Z",
        "externalOperationId": "example",
        "operationId": "123e4567-e89b-12d3-a456-426614174000",
        "operationType": "AUTHORIZE",
        "orderId": "example",
        "params": {},
        "reason": "example",
        "status": "PENDING",
        "updated": "2025-01-01T00:00:00Z"
      }
    ],
    "order": {
      "cart": {
        "cartId": "example",
        "coupons": [
          null
        ],
        "discounts": [
          null
        ],
        "externalId": "example",
        "items": [
          null
        ],
        "measurements": {},
        "total": null
      },
      "coolingPeriodExpiresAt": "2025-09-26T14:55:10.390377+03:00",
      "created": "2025-01-01T00:00:00Z",
      "currencyCode": "RUB",
      "isPrepayment": false,
      "merchantId": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": "example",
      "orderAmount": "123.45",
      "orderId": "example",
      "paymentMethod": {
        "cardLast4": "example",
        "cardNetwork": "AMEX",
        "methodType": "CARD"
      },
      "paymentStatus": "PENDING",
      "paymentUrl": "example",
      "reason": "example",
      "reasonCode": "NOT_ENOUGH_FUNDS",
      "shippingMethod": {
        "courierOption": null,
        "methodType": "DIRECT",
        "pickupOption": null,
        "yandexDeliveryOption": null
      },
      "updated": "2025-01-01T00:00:00Z",
      "fiscalContact": "test@example.com"
    }
  },
  "status": "success"
}

Name

Description

code

Type: unknown

Default: 200

data

Type: OrderResponseData

Example
{
  "delivery": {
    "actualPrice": "123.45",
    "created": "2025-01-01T00:00:00Z",
    "price": "123.45",
    "status": "NEW",
    "updated": "2025-01-01T00:00:00Z"
  },
  "operations": [
    {
      "amount": "123.45",
      "approvalCode": "example",
      "created": "2025-01-01T00:00:00Z",
      "externalOperationId": "example",
      "operationId": "123e4567-e89b-12d3-a456-426614174000",
      "operationType": "AUTHORIZE",
      "orderId": "example",
      "params": {},
      "reason": "example",
      "status": "PENDING",
      "updated": "2025-01-01T00:00:00Z"
    }
  ],
  "order": {
    "cart": {
      "cartId": "example",
      "coupons": [
        {}
      ],
      "discounts": [
        {}
      ],
      "externalId": "example",
      "items": [
        {}
      ],
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "total": null
    },
    "coolingPeriodExpiresAt": "2025-09-26T14:55:10.390377+03:00",
    "created": "2025-01-01T00:00:00Z",
    "currencyCode": "RUB",
    "isPrepayment": false,
    "merchantId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": "example",
    "orderAmount": "123.45",
    "orderId": "example",
    "paymentMethod": {
      "cardLast4": "example",
      "cardNetwork": "AMEX",
      "methodType": "CARD"
    },
    "paymentStatus": "PENDING",
    "paymentUrl": "example",
    "reason": "example",
    "reasonCode": "NOT_ENOUGH_FUNDS",
    "shippingMethod": {
      "courierOption": null,
      "methodType": "DIRECT",
      "pickupOption": null,
      "yandexDeliveryOption": null
    },
    "updated": "2025-01-01T00:00:00Z",
    "fiscalContact": "test@example.com"
  }
}

status

Type: string

Default: success

Const: success

Delivery

Name

Description

price

Type: string<double>

Цена доставки для покупателя

Example: 123.45

actualPrice

Type: string<double>

Цена доставки для продавца

Example: 123.45

created

Type: string<date-time>

Дата и время создания доставки (ISO 8601)

Example: 2025-01-01T00:00:00Z

status

Type: string

Статус доставки

Default: NEW

Enum: NEW, ESTIMATING, EXPIRED, READY_FOR_APPROVAL, COLLECTING, PREPARING, DELIVERING, DELIVERED, RETURNING, RETURNED, FAILED, CANCELLED

updated

Type: string<date-time>

Дата и время обновления доставки (ISO 8601)

Example: 2025-01-01T00:00:00Z
Example
{
  "actualPrice": "123.45",
  "created": "2025-01-01T00:00:00Z",
  "price": "123.45",
  "status": "NEW",
  "updated": "2025-01-01T00:00:00Z"
}

OrderResponseOperation

Name

Description

amount

Type: string<double>

Сумма операции в фиатной валюте

Example: 123.45

operationId

Type: string<uuid>

Max length: 2048

Example: 123e4567-e89b-12d3-a456-426614174000

operationType

Type: string

Enum: AUTHORIZE, BIND_CARD, REFUND, CAPTURE, VOID, RECURRING, PREPAYMENT, SUBMIT

orderId

Type: string

Уникальный идентификатор заказа на стороне продавца.

Используется:

  • как ключ идемпотентности;
  • для дальнейшего взаимодействия по заказу и платежу;
  • в сверках.

Max length: 2048

Example: example

approvalCode

Type: string

Код подтверждения транзакции от процессингового центра.

Example: example

created

Type: string<date-time>

Дата и время создания операции (ISO 8601)

Example: 2025-01-01T00:00:00Z

externalOperationId

Type: string

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

Max length: 2048

Example: example

params

Type: object

Дополнительные параметры операции. Список полей отличается в зависимости от типа операции.

При возврате сохраняются motive, branchId и managerId, которые вы указали в запросе /refund:

{
  "params": {
    "motive": "Товар не устроил", // причина возврата
    "branch_id": "42", // идентификатор точки продаж
    "manager_id": "12345" // идентификатор менеджера
  }
}

При отмене сохраняется reason, который вы указали в запросе /cancel:

{
  "params": {
    "cancel_reason": "Покупатель отказался" // причина отмены
  }
}
Example
{}

reason

Type: string

Причина ошибки

Max length: 2048

Example: example

status

Type: string

Default: PENDING

Enum: PENDING, SUCCESS, FAIL

updated

Type: string<date-time>

Дата и время обновления операции (ISO 8601)

Example: 2025-01-01T00:00:00Z
Example
{
  "amount": "123.45",
  "approvalCode": "example",
  "created": "2025-01-01T00:00:00Z",
  "externalOperationId": "example",
  "operationId": "123e4567-e89b-12d3-a456-426614174000",
  "operationType": "AUTHORIZE",
  "orderId": "example",
  "params": {},
  "reason": "example",
  "status": "PENDING",
  "updated": "2025-01-01T00:00:00Z"
}

Coupon

Name

Description

value

Type: string

Код купона

Max length: 2048

Example: example

description

Type: string

Описание. Например, "Скидка 3%"

Max length: 2048

Example: example

status

Type: string

Enum: VALID, INVALID, EXPIRED, null

Example: VALID
Example
{
  "description": "example",
  "status": "VALID",
  "value": "example"
}

Discount

Name

Description

amount

Type: string<double>

Сумма скидки

Example: 123.45

description

Type: string

Текстовое описание

Max length: 2048

Example: example

discountId

Type: string

Идентификатор скидки в системе мерчанта

Max length: 2048

Example: example
Example
{
  "amount": "123.45",
  "description": "example",
  "discountId": "example"
}

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"
}

Measurements

Name

Description

height

Type: number

Высота, в метрах

length

Type: number

Длина, в метрах

weight

Type: number

Вес, в килограммах

width

Type: number

Ширина, в метрах
Example
{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

ItemQuantity

Name

Description

count

Type: string<double>

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example: 123.45

available

Type: string<double>

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

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

PaymentsOperator

Name

Description

phones

Type: string[]

Example
[
  "example"
]
Example
{
  "phones": [
    "example"
  ]
}

TransferOperator

Name

Description

address

Type: string

Max length: 2048

Example: example

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

Example
[
  "example"
]
Example
{
  "address": "example",
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

Agent

Name

Description

agentType

Type: integer

Признак агента по предмету расчета. См. значения

Enum: 1, 2, 3, 4, 5, 6, 7

operation

Type: string

Max length: 2048

Example: example

paymentsOperator

Type: PaymentsOperator

Example
{
  "phones": [
    "example"
  ]
}

phones

Type: string[]

Example
[
  "example"
]

transferOperator

Type: TransferOperator

Example
{
  "address": "example",
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}
Example
{
  "agentType": 1,
  "operation": "example",
  "paymentsOperator": {
    "phones": [
      "example"
    ]
  },
  "phones": [
    "example"
  ],
  "transferOperator": {
    "address": "example",
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  }
}

MarkQuantity

Name

Description

denominator

Type: integer

numerator

Type: integer
Example
{
  "denominator": 0,
  "numerator": 0
}

Supplier

Name

Description

inn

Type: string

Max length: 2048

Example: example

name

Type: string

Max length: 2048

Example: example

phones

Type: string[]

Example
[
  "example"
]
Example
{
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

ItemReceipt

Данные для формирования чека.

Name

Description

tax

Type: integer

Ставка НДС. Описание значений: Ссылка.

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

agent

Type: Agent

Example
{
  "agentType": 1,
  "operation": "example",
  "paymentsOperator": {
    "phones": [
      "example"
    ]
  },
  "phones": [
    "example"
  ],
  "transferOperator": {
    "address": "example",
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  }
}

excise

Type: string<double>

Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 .

Example: 123.45

markQuantity

Type: MarkQuantity

Example
{
  "denominator": 0,
  "numerator": 0
}

measure

Type: integer

Описание значений: Ссылка

Enum: 0, 10, 11, 12, 20, 21, 22, 30, 31, 32, 40, 41, 42, 50, 51, 70, 71, 72, 73, 80, 81, 82, 83, 255, null

paymentMethodType

Type: integer

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, null

paymentSubjectType

Type: integer

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, null

productCode

Type: string<base64>

Код товара (base64 кодированный массив от 1 до 32 байт)

Example: example

supplier

Type: Supplier

Example
{
  "inn": "example",
  "name": "example",
  "phones": [
    "example"
  ]
}

title

Type: string

Max length: 2048

Example: example
Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

CartItem

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"
}

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"
}

finalPrice

Type: string<double>

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

Example: 123.45

measurements
All of 1 type

  • Type: Measurements

    Example
    {
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

Размеры и вес товара. Обязательно для товара типа PHYSICAL

Example
{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

pointsAmount

Type: string<double>

Количество баллов Плюса

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

Example: 123.45

receipt
All of 1 type

  • Type: ItemReceipt

    Данные для формирования чека.

    Example
    {
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

Данные для формирования чека.

Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

skuId

Type: string

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

Max length: 2048

Example: example

subtotal

Type: string<double>

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

Example: 123.45

title

Type: string

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

Max length: 2048

Example: example

total

Type: string<double>

Итоговая цена позиции с учетом примененных скидок.

Важно

Убедитесь, что цена за единицу товара (total / quantity.count) имеет максимум 2 знака в дробной части. Иначе вернется ошибка ORDER_CART_DATA_ERROR.

Чтобы избежать ошибок, вынесите товары в отдельные позиции с разными productId.

Пример

Правильно:

{
  "productId": "xxx-123",
  "quantity": {
    "count": "2"
  },
  "title": "Мармелад",
  "total": "100.50"
}

Цена за единицу 100.50 / 2 = 50.25 c двумя знаками в дробной части.

Неправильно:

{
  "productId": "xxx-123",
  "quantity": {
    "count": "2"
  },
  "title": "Мармелад",
  "total": "100.25"
}

Цена за единицу 100.25 / 2 = 50.125 c тремя знаками в дробной части.

В таком случае разбейте на две позиции:

[
  {
    "productId": "xxx-123-1",
    "quantity": {
      "count": "1"
    },
    "title": "Мармелад",
    "total": "50.25"
  },
  {
    "productId": "xxx-123-2",
    "quantity": {
      "count": "1"
    },
    "title": "Мармелад со скидкой",
    "total": "50"
  }
]

Example: 123.45

type

Type: string

Тип товара. Важен для интеграции с доставками

Default: UNSPECIFIED

Enum: PHYSICAL, DIGITAL, UNSPECIFIED

unitPrice

Type: string<double>

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

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "finalPrice": "123.45",
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "pointsAmount": "123.45",
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

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

Это поле обязательно для формирования чека, если в личном кабинете подключена фискализация через Яндекс Пэй.

Example: 123.45

externalAmount

Type: string<double>

Сумма внешней оплаты (сертификаты, подарочные карты, баллы лояльности).

Может быть не указана, равна 0 или больше 0.

Ограничения:

  • Нельзя создать заказ с amount: "0" (полная оплата внешними средствами). Минимальная сумма для оплаты через Яндекс Пэй — 1 рубль.
  • Сумма amount + externalAmount должна равняться сумме всех items в корзине.
  • (Для двухстадийных платежей) При списании средств методом /orders/{order_id}/capture не должна превышать значение, переданное в /orders при создании заказа.

Example: 123.45

pointsAmount

Type: string<double>

Количество баллов Плюса

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

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

Cart

Name

Description

items

Type: CartItem[]

Позиция корзины

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    },
    "finalPrice": "123.45",
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "pointsAmount": "123.45",
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45"
    },
    "receipt": {
      "agent": {
        "agentType": 1,
        "operation": "example",
        "paymentsOperator": {},
        "phones": [
          null
        ],
        "transferOperator": {}
      },
      "excise": "123.45",
      "markQuantity": {
        "denominator": 0,
        "numerator": 0
      },
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      },
      "tax": 1,
      "title": "example"
    },
    "skuId": "example",
    "subtotal": "123.45",
    "title": "example",
    "total": "123.45",
    "type": "UNSPECIFIED",
    "unitPrice": "123.45"
  }
]

cartId

Type: string

Внутренний идентификатор корзины на стороне Яндекс Пэй.

Max length: 2048

Example: example

coupons

Type: Coupon[]

Купоны, примененные к корзине

Example
[
  {
    "description": "example",
    "status": "VALID",
    "value": "example"
  }
]

discounts

Type: Discount[]

Скидки, примененные к корзине

Example
[
  {
    "amount": "123.45",
    "description": "example",
    "discountId": "example"
  }
]

externalId

Type: string

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

Max length: 2048

Example: example

measurements

Type: Measurements

Example
{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

total
All of 1 type

  • Type: CartTotal

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

Итоговая стоимость корзины, которая пойдет в оплату

Default: null
Example
{
  "cartId": "example",
  "coupons": [
    {
      "description": "example",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "finalPrice": "123.45",
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

PaymentMethod

Name

Description

methodType

Type: string

Enum: CARD, SPLIT, SBP, SPLIT_SBP, CASH_ON_DELIVERY, CARD_ON_DELIVERY, UNIQR_REUSABLE, UNIQR_ONETIME

cardLast4

Type: string

Max length: 2048

Example: example

cardNetwork

Type: string

Платежная система

Enum: AMEX, DISCOVER, JCB, MASTERCARD, MAESTRO, VISAELECTRON, VISA, MIR, UNIONPAY, UZCARD, HUMOCARD, UNKNOWN, UNDEFINED, null

Example: AMEX
Example
{
  "cardLast4": "example",
  "cardNetwork": "AMEX",
  "methodType": "CARD"
}

TimeInterval

Name

Description

end

Type: string

Время конца интервала

Example: example

start

Type: string

Время начала интервала

Example: example
Example
{
  "end": "example",
  "start": "example"
}

FlexibleCustomerChoice

Name

Description

date

Type: string<date>

Example: 2025-01-01

time

Type: TimeInterval

Example
{
  "end": "example",
  "start": "example"
}
Example
{
  "date": "2025-01-01",
  "time": {
    "end": "example",
    "start": "example"
  }
}

FlexibleTimeIntervalsGridDescriptor

Name

Description

duration

Type: string

Продолжительность каждого интервала

Example: example

end

Type: string

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

Example: example

start

Type: string

Время начала самого первого интервала

Example: example

step

Type: string

Разница во времени между началами двух соседних интервалов

Example: example
Example
{
  "duration": "example",
  "end": "example",
  "start": "example",
  "step": "example"
}

FlexibleTimeIntervals

Name

Description

type

Type: string

Если указан тип GRID, то необходимо задать поле grid. Если указан тип VALUES, то необходимо задать поле values

Enum: GRID, VALUES

grid
All of 1 type

Кодирует интервалы в виде сетки. Используйте этот формат, если необходимо задать больше 20 интервалов доставки. Пример: {"start": "09:00", "end": "21:00", "duration": "00:20", "step": "01:00"} трактуется как набор интервалов: [{"start": "09:00", "end": "09:20"}, {"start": "10:00", "end": "10:20"}, ..., {"start": "20:00", "end": "20:20"}]

Example
{
  "duration": "example",
  "end": "example",
  "start": "example",
  "step": "example"
}

values

Type: TimeInterval[]

Задает список интервалов напрямую. Подходит для небольшого количества интервалов доставки. Рекомендуемое максимальная количество интервалов - 20

Example
[
  {
    "end": "example",
    "start": "example"
  }
]
Example
{
  "grid": {
    "duration": "example",
    "end": "example",
    "start": "example",
    "step": "example"
  },
  "type": "GRID",
  "values": [
    {
      "end": "example",
      "start": "example"
    }
  ]
}

CourierOption

Name

Description

amount

Type: string<double>

Стоимость доставки

Example: 123.45

category

Type: string

Enum: EXPRESS, TODAY, STANDARD

courierOptionId

Type: string

id выбранного варианта доставки в системе продавца

Max length: 2048

Example: example

title

Type: string

Название способа доставки. Показывается пользователю в списке вариантов

Max length: 2048

Example: example

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Example
[
  "CARD"
]

customerChoice
All of 1 type

  • Type: FlexibleCustomerChoice

    Example
    {
  "date": "2025-01-01",
  "time": {
    "end": "example",
    "start": "example"
  }
}

Выбранные пользователем дата и интервал. Только для type: FLEXIBLE

Example
{
  "date": "2025-01-01",
  "time": {
    "end": "example",
    "start": "example"
  }
}

fromDate

Type: string<date>

Ближайшая дата доставки для type: PLAIN. Начало интервала выбора даты доставки для type: FLEXIBLE

Example: 2025-01-01

fromTime

Type: string

Начало интервала времени доставки. Только для type: PLAIN

Example: example

provider

Type: string

Тип службы доставки.

Enum: BOXBERRY, CDEK, RUSSIAN_POST, EMS, COURIER, DHL, EXPRESS_DELIVERY, FIVEPOST, OZON_ROCKET, DPD, SBER_LOGISTICS, PEK, PICKPOINT, KCE, PONY_EXPRESS, YANDEX_DELIVERY, null

Example: BOXBERRY

receipt
All of 1 type

  • Type: ItemReceipt

    Данные для формирования чека.

    Example
    {
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

Данные для формирования чека.

Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

timeIntervals
All of 1 type

  • Type: FlexibleTimeIntervals

    Example
    {
  "grid": {
    "duration": "example",
    "end": "example",
    "start": "example",
    "step": "example"
  },
  "type": "GRID",
  "values": [
    {
      "end": "example",
      "start": "example"
    }
  ]
}

Кодирует интервалы времени доставки, доступные для выбора. Только для type: FLEXIBLE

Example
{
  "grid": {
    "duration": "example",
    "end": "example",
    "start": "example",
    "step": "example"
  },
  "type": "GRID",
  "values": [
    {
      "end": "example",
      "start": "example"
    }
  ]
}

toDate

Type: string<date>

Самая поздняя дата доставки для type: PLAIN. Конец интервала выбора даты доставки для type: FLEXIBLE

Example: 2025-01-01

toTime

Type: string

Конец интервала времени доставки. Только для type: PLAIN

Example: example

type

Type: string

Тип опции. Для FLEXIBLE вариантов доставки пользователю дается возможность выбрать желаемые дату и интервал:

  • дата доставки выбирается покупателем в отрезке [fromDate, toDate]
  • чтобы предоставить пользователю выбор интервала в течении дня, заполните timeIntervals Для PLAIN вариантов такой выбор отсутствует.

Default: PLAIN

Enum: PLAIN, FLEXIBLE
Example
{
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "courierOptionId": "example",
  "customerChoice": {
    "date": "2025-01-01",
    "time": {
      "end": "example",
      "start": "example"
    }
  },
  "fromDate": "2025-01-01",
  "fromTime": "example",
  "provider": "BOXBERRY",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "timeIntervals": {
    "grid": {
      "duration": "example",
      "end": "example",
      "start": "example",
      "step": "example"
    },
    "type": "GRID",
    "values": [
      null
    ]
  },
  "title": "example",
  "toDate": "2025-01-01",
  "toTime": "example",
  "type": "PLAIN"
}

Location

Name

Description

latitude

Type: number

longitude

Type: number
Example
{
  "latitude": 0.5,
  "longitude": 0.5
}

PickupSchedule

Name

Description

fromTime

Type: string

HH:mm, "08:00"

Example: example

label

Type: string

Например, "пн-пт"

Max length: 2048

Example: example

toTime

Type: string

HH:mm, "20:00"

Example: example
Example
{
  "fromTime": "example",
  "label": "example",
  "toTime": "example"
}

PickupOption

Name

Description

address

Type: string

Адрес в виде строки

Max length: 2048

Example: example

location

Type: Location

Example
{
  "latitude": 0.5,
  "longitude": 0.5
}

pickupPointId

Type: string

Уникальный id точки самовывоза в системе продавца

Max length: 2048

Example: example

title

Type: string

Название точки самовывоза

Max length: 2048

Example: example

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Example
[
  "CARD"
]

amount

Type: string<double>

Стоимость доставки в точку

Example: 123.45

description

Type: string

Дополнительное описание

Max length: 2048

Example: example

fromDate

Type: string<date>

YYYY-MM-DD. Ближайшая возможная дата доставки

Example: 2025-01-01

phones

Type: string[]

Телефоны для связи

Example
[
  "example"
]

provider

Type: string

Тип точки вывоза.

Enum: YANDEX_MARKET, BOXBERRY, CDEK, IN_STORE, RUSSIAN_POST, PICKPOINT, DPD

receipt
All of 1 type

  • Type: ItemReceipt

    Данные для формирования чека.

    Example
    {
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

Данные для формирования чека.

Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

schedule

Type: PickupSchedule[]

График работы точки

Example
[
  {
    "fromTime": "example",
    "label": "example",
    "toTime": "example"
  }
]

storagePeriod

Type: integer

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

toDate

Type: string<date>

YYYY-MM-DD. Самая поздняя дата доставки

Example: 2025-01-01
Example
{
  "address": "example",
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "description": "example",
  "fromDate": "2025-01-01",
  "location": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "phones": [
    "example"
  ],
  "pickupPointId": "example",
  "provider": "YANDEX_MARKET",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "schedule": [
    {
      "fromTime": "example",
      "label": "example",
      "toTime": "example"
    }
  ],
  "storagePeriod": 0,
  "title": "example",
  "toDate": "2025-01-01"
}

YandexDeliveryOption

Name

Description

amount

Type: string<double>

Стоимость доставки

Example: 123.45

category

Type: string

Enum: EXPRESS, TODAY, STANDARD

title

Type: string

Название способа доставки. Показывается пользователю в списке вариантов

Max length: 2048

Example: example

yandexDeliveryOptionId

Type: string

Id предложения Яндекс Доставки

Max length: 2048

Example: example

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для метода доставки. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Example
[
  "CARD"
]

fromDatetime

Type: string<date-time>

Example: 2025-01-01T00:00:00Z

receipt
All of 1 type

  • Type: ItemReceipt

    Данные для формирования чека.

    Example
    {
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

Данные для формирования чека.

Example
{
  "agent": {
    "agentType": 1,
    "operation": "example",
    "paymentsOperator": {
      "phones": [
        "example"
      ]
    },
    "phones": [
      "example"
    ],
    "transferOperator": {
      "address": "example",
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    }
  },
  "excise": "123.45",
  "markQuantity": {
    "denominator": 0,
    "numerator": 0
  },
  "measure": 0,
  "paymentMethodType": 1,
  "paymentSubjectType": 1,
  "productCode": "example",
  "supplier": {
    "inn": "example",
    "name": "example",
    "phones": [
      "example"
    ]
  },
  "tax": 1,
  "title": "example"
}

toDatetime

Type: string<date-time>

Example: 2025-01-01T00:00:00Z
Example
{
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "fromDatetime": "2025-01-01T00:00:00Z",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "title": "example",
  "toDatetime": "2025-01-01T00:00:00Z",
  "yandexDeliveryOptionId": "example"
}

ShippingMethod

Name

Description

methodType

Type: string

Enum: DIRECT, PICKUP, COURIER, YANDEX_DELIVERY

courierOption
All of 1 type

  • Type: CourierOption

    Example
    {
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "courierOptionId": "example",
  "customerChoice": {
    "date": "2025-01-01",
    "time": {
      "end": "example",
      "start": "example"
    }
  },
  "fromDate": "2025-01-01",
  "fromTime": "example",
  "provider": "BOXBERRY",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "timeIntervals": {
    "grid": {
      "duration": "example",
      "end": "example",
      "start": "example",
      "step": "example"
    },
    "type": "GRID",
    "values": [
      null
    ]
  },
  "title": "example",
  "toDate": "2025-01-01",
  "toTime": "example",
  "type": "PLAIN"
}

если methodType == COURIER

Example
{
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "courierOptionId": "example",
  "customerChoice": {
    "date": "2025-01-01",
    "time": {
      "end": "example",
      "start": "example"
    }
  },
  "fromDate": "2025-01-01",
  "fromTime": "example",
  "provider": "BOXBERRY",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {},
      "phones": [
        null
      ],
      "transferOperator": {}
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        null
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "timeIntervals": {
    "grid": null,
    "type": "GRID",
    "values": [
      null
    ]
  },
  "title": "example",
  "toDate": "2025-01-01",
  "toTime": "example",
  "type": "PLAIN"
}

pickupOption
All of 1 type

  • Type: PickupOption

    Example
    {
  "address": "example",
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "description": "example",
  "fromDate": "2025-01-01",
  "location": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "phones": [
    "example"
  ],
  "pickupPointId": "example",
  "provider": "YANDEX_MARKET",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "schedule": [
    {
      "fromTime": "example",
      "label": "example",
      "toTime": "example"
    }
  ],
  "storagePeriod": 0,
  "title": "example",
  "toDate": "2025-01-01"
}

если methodType == PICKUP

Example
{
  "address": "example",
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "description": "example",
  "fromDate": "2025-01-01",
  "location": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "phones": [
    "example"
  ],
  "pickupPointId": "example",
  "provider": "YANDEX_MARKET",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {},
      "phones": [
        null
      ],
      "transferOperator": {}
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        null
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "schedule": [
    {
      "fromTime": "example",
      "label": "example",
      "toTime": "example"
    }
  ],
  "storagePeriod": 0,
  "title": "example",
  "toDate": "2025-01-01"
}

yandexDeliveryOption
All of 1 type

  • Type: YandexDeliveryOption

    Example
    {
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "fromDatetime": "2025-01-01T00:00:00Z",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          null
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          null
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "title": "example",
  "toDatetime": "2025-01-01T00:00:00Z",
  "yandexDeliveryOptionId": "example"
}

если methodType == YANDEX_DELIVERY

Example
{
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "fromDatetime": "2025-01-01T00:00:00Z",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {},
      "phones": [
        null
      ],
      "transferOperator": {}
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        null
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "title": "example",
  "toDatetime": "2025-01-01T00:00:00Z",
  "yandexDeliveryOptionId": "example"
}
Example
{
  "courierOption": {
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "category": "EXPRESS",
    "courierOptionId": "example",
    "customerChoice": {
      "date": "2025-01-01",
      "time": {}
    },
    "fromDate": "2025-01-01",
    "fromTime": "example",
    "provider": "BOXBERRY",
    "receipt": {
      "agent": {},
      "excise": "123.45",
      "markQuantity": {},
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {},
      "tax": 1,
      "title": "example"
    },
    "timeIntervals": {
      "grid": null,
      "type": "GRID",
      "values": [
        null
      ]
    },
    "title": "example",
    "toDate": "2025-01-01",
    "toTime": "example",
    "type": "PLAIN"
  },
  "methodType": "DIRECT",
  "pickupOption": {
    "address": "example",
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "description": "example",
    "fromDate": "2025-01-01",
    "location": {
      "latitude": 0.5,
      "longitude": 0.5
    },
    "phones": [
      "example"
    ],
    "pickupPointId": "example",
    "provider": "YANDEX_MARKET",
    "receipt": null,
    "schedule": [
      {
        "fromTime": "example",
        "label": "example",
        "toTime": "example"
      }
    ],
    "storagePeriod": 0,
    "title": "example",
    "toDate": "2025-01-01"
  },
  "yandexDeliveryOption": {
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "category": "EXPRESS",
    "fromDatetime": "2025-01-01T00:00:00Z",
    "receipt": null,
    "title": "example",
    "toDatetime": "2025-01-01T00:00:00Z",
    "yandexDeliveryOptionId": "example"
  }
}

BaseMerchantApiOrder

Name

Description

cart
All of 1 type

  • Type: Cart

    Example
    {
  "cartId": "example",
  "coupons": [
    {
      "description": "example",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "finalPrice": "123.45",
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

Корзина

Example
{
  "cartId": "example",
  "coupons": [
    {
      "description": "example",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "123.45",
      "features": null,
      "finalPrice": "123.45",
      "measurements": null,
      "pointsAmount": "123.45",
      "productId": "example",
      "quantity": null,
      "receipt": null,
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

currencyCode

Type: string

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

Enum: RUB, UZS

Max length: 2048

coolingPeriodExpiresAt

Type: string<date-time>

Дата и время окончания периода «охлаждения» (ISO 8601).

Доступен только в статусе PENDING — покупатель улучшил Сплит (вошел в процесс «охлаждения»), ожидается окончание «охлаждения» и оплата.

После перехода заказа в другие статусы — значение null.

Важно

Наличие поля coolingPeriodExpiresAt в ответе API означает, что в соответствии с федеральным законом №9‑ФЗ от 13.02.2025 г. для операции действует период «охлаждения». При приёме ответа обязательно реализуйте обработку этого поля. Несоблюдение этого требования может привести к нарушению законодательства.

Example: 2025-09-26T14:55:10.390377+03:00

created

Type: string<date-time>

Дата и время создания заказа (ISO 8601)

Example: 2025-01-01T00:00:00Z

fiscalContact

Type: string

Контактные данные покупателя (почта или номер телефона) для отправки электронного фискального чека.

Рекомендуемые форматы для телефона: +71234567890 или 71234567890.

Все символы, кроме цифр, игнорируются. Номера, начинающиеся с 8 обрабатываются как +7.

Например, 71234567890, +71234567890, 81234567890, +7 (123) 456-78-90 обрабатываются как 71234567890.

Example: test@example.com

isPrepayment

Type: boolean

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

Используется в механике Сплит c оплатой «при получении».

Default: false

merchantId

Type: string<uuid>

Max length: 2048

Example: 123e4567-e89b-12d3-a456-426614174000

metadata

Type: string

Произвольные данные, переданные при инициализации кнопки

Max length: 2048

Example: example

orderAmount

Type: string<double>

Полная стоимость заказа к оплате с учетом возвратов, доставки, скидок и промокодов

Example: 123.45

orderId

Type: string

Уникальный идентификатор заказа на стороне продавца.

Используется:

  • как ключ идемпотентности;
  • для дальнейшего взаимодействия по заказу и платежу;
  • в сверках.

Max length: 2048

Example: example

paymentMethod

Type: PaymentMethod

Example
{
  "cardLast4": "example",
  "cardNetwork": "AMEX",
  "methodType": "CARD"
}

paymentStatus

Type: string

Статус платежа в заказе. Подробнее читайте в разделе Статусы платежей.

Не может быть null.

Enum: PENDING, AUTHORIZED, CAPTURED, VOIDED, REFUNDED, CONFIRMED, PARTIALLY_REFUNDED, FAILED, null

Example: PENDING

paymentUrl

Type: string

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

Max length: 2048

Example: example

reason

Type: string

Причина ошибки (применимо для статусов VOIDED/FAILED)

Max length: 2048

Example: example

reasonCode

Type: string | null

Код ошибки (применимо для статусов VOIDED и FAILED).

Используйте, чтобы отобразить ошибку для покупателя.

  • NOT_ENOUGH_FUNDS — Недостаточно средств на счете покупателя.
  • CARD_LIMIT_EXCEEDED — Достигнуты лимиты по операциям с картой. Например, суточные/месячные ограничения, лимит на сумму транзакции.
  • CARD_EXPIRED — Истек срок действия карты.
  • CARD_OPERATION_NOT_AVAILABLE — Операция недоступна для этой карты. Появляется в следующих случаях:
    • карта недействительна (украдена, утеряна);
    • установлены ограничения пользователем или банком. Например, действует запрет на интернет-транзакции.
  • TRANSACTION_ACQUIRING_ERROR — Платеж отклонен. Выберите другой способ оплаты или попробуйте оплатить позже.
  • INVALID_CONFIRMATION_CODE — Неверно введен код. Например, CVV или код из СМС.
  • THREEDS_ERROR — Проблема в прохождении 3DS. Выберите другой способ оплаты или попробуйте оплатить позже.
  • PAYMENT_TIMEOUT — Покупатель не успел завершить оплату в отведенное время (СБП/3DS). Попробуйте оплатить заново.
  • ORDER_NOT_FOUND — Заказ не найден. Пересоздайте заказ.
  • MERCHANT_AUTH_ERROR — Ошибка авторизации продавца. Проверьте API-ключ и пересоздайте заказ.
  • INVALID_AMOUNT — Техническая ошибка Яндекс Пэй при неправильной сумме заказа. Пересоздайте заказ.
  • RECEIPT_ERROR — Ошибка создания чека на стороне Яндекс Пэй. Проверьте параметры запроса, необходимые для фискализации.
  • CLIENTS_BANK_REJECT — Операция отклонена банком покупателя.
  • BINDING_NOT_FOUND — Ошибка привязки карты. Привяжите карту и пересоздайте заказ.
  • CARD_CHALLENGE_FAILED — Не удалось верифицировать карту. Проверьте правильность данных карты или используйте другую карту.
  • ISSUER_COUNTRY_NOT_SUPPORTED — Карта покупателя выпущена банком из неподдерживаемой страны. Выберите другой способ оплаты.
  • UNKNOWN — Неизвестная ошибка.
  • ORDER_TTL_REACHED — Истек срок оплаты по ссылке.
  • USER_DID_NOT_START_PAYMENT — Покупатель не начал процесс оплаты. Заказ можно считать неоплаченным.
  • PAYMENT_RETRIED_BY_USER — Покупатель начал новую попытку оплаты, например, обновил страницу оплаты. Предыдущая транзакция будет отменена с этой ошибкой.
  • ORDER_CANCELED — Заказ отменен на стороне продавца. Например, произошла техническая ошибка или часть товаров уже закончилась. Пересоздайте заказ.
  • USER_CANCELLED_PAYMENT — Покупатель прервал оплату на этапе прохождения 3DS/2FA.

Enum: NOT_ENOUGH_FUNDS, CARD_LIMIT_EXCEEDED, CARD_EXPIRED, CARD_OPERATION_NOT_AVAILABLE, TRANSACTION_ACQUIRING_ERROR, INVALID_CONFIRMATION_CODE, THREEDS_ERROR, PAYMENT_TIMEOUT, ORDER_NOT_FOUND, MERCHANT_AUTH_ERROR, INVALID_AMOUNT, RECEIPT_ERROR, CLIENTS_BANK_REJECT, BINDING_NOT_FOUND, CARD_CHALLENGE_FAILED, ISSUER_COUNTRY_NOT_SUPPORTED, UNKNOWN, ORDER_TTL_REACHED, USER_DID_NOT_START_PAYMENT, PAYMENT_RETRIED_BY_USER, ORDER_CANCELED, USER_CANCELLED_PAYMENT, QR_TTL_REACHED, SBP_BINDING_ERROR, CLIENT_REFUSED_BINDING, null

Example: NOT_ENOUGH_FUNDS

shippingMethod
All of 1 type

  • Type: ShippingMethod

    Example
    {
  "courierOption": {
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "category": "EXPRESS",
    "courierOptionId": "example",
    "customerChoice": {
      "date": "2025-01-01",
      "time": {}
    },
    "fromDate": "2025-01-01",
    "fromTime": "example",
    "provider": "BOXBERRY",
    "receipt": {
      "agent": {},
      "excise": "123.45",
      "markQuantity": {},
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": {},
      "tax": 1,
      "title": "example"
    },
    "timeIntervals": {
      "grid": null,
      "type": "GRID",
      "values": [
        null
      ]
    },
    "title": "example",
    "toDate": "2025-01-01",
    "toTime": "example",
    "type": "PLAIN"
  },
  "methodType": "DIRECT",
  "pickupOption": {
    "address": "example",
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "description": "example",
    "fromDate": "2025-01-01",
    "location": {
      "latitude": 0.5,
      "longitude": 0.5
    },
    "phones": [
      "example"
    ],
    "pickupPointId": "example",
    "provider": "YANDEX_MARKET",
    "receipt": null,
    "schedule": [
      {
        "fromTime": "example",
        "label": "example",
        "toTime": "example"
      }
    ],
    "storagePeriod": 0,
    "title": "example",
    "toDate": "2025-01-01"
  },
  "yandexDeliveryOption": {
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "category": "EXPRESS",
    "fromDatetime": "2025-01-01T00:00:00Z",
    "receipt": null,
    "title": "example",
    "toDatetime": "2025-01-01T00:00:00Z",
    "yandexDeliveryOptionId": "example"
  }
}

Выбранный способ доставки

Example
{
  "courierOption": {
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "category": "EXPRESS",
    "courierOptionId": "example",
    "customerChoice": null,
    "fromDate": "2025-01-01",
    "fromTime": "example",
    "provider": "BOXBERRY",
    "receipt": null,
    "timeIntervals": null,
    "title": "example",
    "toDate": "2025-01-01",
    "toTime": "example",
    "type": "PLAIN"
  },
  "methodType": "DIRECT",
  "pickupOption": {
    "address": "example",
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "description": "example",
    "fromDate": "2025-01-01",
    "location": {
      "latitude": 0.5,
      "longitude": 0.5
    },
    "phones": [
      "example"
    ],
    "pickupPointId": "example",
    "provider": "YANDEX_MARKET",
    "receipt": null,
    "schedule": [
      {}
    ],
    "storagePeriod": 0,
    "title": "example",
    "toDate": "2025-01-01"
  },
  "yandexDeliveryOption": {
    "allowedPaymentMethods": [
      "CARD"
    ],
    "amount": "123.45",
    "category": "EXPRESS",
    "fromDatetime": "2025-01-01T00:00:00Z",
    "receipt": null,
    "title": "example",
    "toDatetime": "2025-01-01T00:00:00Z",
    "yandexDeliveryOptionId": "example"
  }
}

updated

Type: string<date-time>

Дата и время обновления заказа (ISO 8601)

Example: 2025-01-01T00:00:00Z
Example
{
  "cart": {
    "cartId": "example",
    "coupons": [
      {
        "description": "example",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "features": null,
        "finalPrice": "123.45",
        "measurements": null,
        "pointsAmount": "123.45",
        "productId": "example",
        "quantity": null,
        "receipt": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "type": "UNSPECIFIED",
        "unitPrice": "123.45"
      }
    ],
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "total": null
  },
  "coolingPeriodExpiresAt": "2025-09-26T14:55:10.390377+03:00",
  "created": "2025-01-01T00:00:00Z",
  "currencyCode": "RUB",
  "isPrepayment": false,
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": "example",
  "orderAmount": "123.45",
  "orderId": "example",
  "paymentMethod": {
    "cardLast4": "example",
    "cardNetwork": "AMEX",
    "methodType": "CARD"
  },
  "paymentStatus": "PENDING",
  "paymentUrl": "example",
  "reason": "example",
  "reasonCode": "NOT_ENOUGH_FUNDS",
  "shippingMethod": {
    "courierOption": {
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "courierOptionId": "example",
      "customerChoice": null,
      "fromDate": "2025-01-01",
      "fromTime": "example",
      "provider": "BOXBERRY",
      "receipt": null,
      "timeIntervals": null,
      "title": "example",
      "toDate": "2025-01-01",
      "toTime": "example",
      "type": "PLAIN"
    },
    "methodType": "DIRECT",
    "pickupOption": {
      "address": "example",
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "description": "example",
      "fromDate": "2025-01-01",
      "location": {},
      "phones": [
        null
      ],
      "pickupPointId": "example",
      "provider": "YANDEX_MARKET",
      "receipt": null,
      "schedule": [
        null
      ],
      "storagePeriod": 0,
      "title": "example",
      "toDate": "2025-01-01"
    },
    "yandexDeliveryOption": {
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "fromDatetime": "2025-01-01T00:00:00Z",
      "receipt": null,
      "title": "example",
      "toDatetime": "2025-01-01T00:00:00Z",
      "yandexDeliveryOptionId": "example"
    }
  },
  "updated": "2025-01-01T00:00:00Z",
  "fiscalContact": "test@example.com"
}

OrderResponseData

Name

Description

delivery

Type: Delivery

Example
{
  "actualPrice": "123.45",
  "created": "2025-01-01T00:00:00Z",
  "price": "123.45",
  "status": "NEW",
  "updated": "2025-01-01T00:00:00Z"
}

operations

Type: OrderResponseOperation[]

Example
[
  {
    "amount": "123.45",
    "approvalCode": "example",
    "created": "2025-01-01T00:00:00Z",
    "externalOperationId": "example",
    "operationId": "123e4567-e89b-12d3-a456-426614174000",
    "operationType": "AUTHORIZE",
    "orderId": "example",
    "params": {},
    "reason": "example",
    "status": "PENDING",
    "updated": "2025-01-01T00:00:00Z"
  }
]

order

Type: BaseMerchantApiOrder

Example
{
  "cart": {
    "cartId": "example",
    "coupons": [
      {
        "description": "example",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "features": null,
        "finalPrice": "123.45",
        "measurements": null,
        "pointsAmount": "123.45",
        "productId": "example",
        "quantity": null,
        "receipt": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "type": "UNSPECIFIED",
        "unitPrice": "123.45"
      }
    ],
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "total": null
  },
  "coolingPeriodExpiresAt": "2025-09-26T14:55:10.390377+03:00",
  "created": "2025-01-01T00:00:00Z",
  "currencyCode": "RUB",
  "isPrepayment": false,
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": "example",
  "orderAmount": "123.45",
  "orderId": "example",
  "paymentMethod": {
    "cardLast4": "example",
    "cardNetwork": "AMEX",
    "methodType": "CARD"
  },
  "paymentStatus": "PENDING",
  "paymentUrl": "example",
  "reason": "example",
  "reasonCode": "NOT_ENOUGH_FUNDS",
  "shippingMethod": {
    "courierOption": {
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "courierOptionId": "example",
      "customerChoice": null,
      "fromDate": "2025-01-01",
      "fromTime": "example",
      "provider": "BOXBERRY",
      "receipt": null,
      "timeIntervals": null,
      "title": "example",
      "toDate": "2025-01-01",
      "toTime": "example",
      "type": "PLAIN"
    },
    "methodType": "DIRECT",
    "pickupOption": {
      "address": "example",
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "description": "example",
      "fromDate": "2025-01-01",
      "location": {},
      "phones": [
        null
      ],
      "pickupPointId": "example",
      "provider": "YANDEX_MARKET",
      "receipt": null,
      "schedule": [
        null
      ],
      "storagePeriod": 0,
      "title": "example",
      "toDate": "2025-01-01"
    },
    "yandexDeliveryOption": {
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "fromDatetime": "2025-01-01T00:00:00Z",
      "receipt": null,
      "title": "example",
      "toDatetime": "2025-01-01T00:00:00Z",
      "yandexDeliveryOptionId": "example"
    }
  },
  "updated": "2025-01-01T00:00:00Z",
  "fiscalContact": "test@example.com"
}
Example
{
  "delivery": {
    "actualPrice": "123.45",
    "created": "2025-01-01T00:00:00Z",
    "price": "123.45",
    "status": "NEW",
    "updated": "2025-01-01T00:00:00Z"
  },
  "operations": [
    {
      "amount": "123.45",
      "approvalCode": "example",
      "created": "2025-01-01T00:00:00Z",
      "externalOperationId": "example",
      "operationId": "123e4567-e89b-12d3-a456-426614174000",
      "operationType": "AUTHORIZE",
      "orderId": "example",
      "params": {},
      "reason": "example",
      "status": "PENDING",
      "updated": "2025-01-01T00:00:00Z"
    }
  ],
  "order": {
    "cart": {
      "cartId": "example",
      "coupons": [
        {}
      ],
      "discounts": [
        {}
      ],
      "externalId": "example",
      "items": [
        {}
      ],
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "total": null
    },
    "coolingPeriodExpiresAt": "2025-09-26T14:55:10.390377+03:00",
    "created": "2025-01-01T00:00:00Z",
    "currencyCode": "RUB",
    "isPrepayment": false,
    "merchantId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": "example",
    "orderAmount": "123.45",
    "orderId": "example",
    "paymentMethod": {
      "cardLast4": "example",
      "cardNetwork": "AMEX",
      "methodType": "CARD"
    },
    "paymentStatus": "PENDING",
    "paymentUrl": "example",
    "reason": "example",
    "reasonCode": "NOT_ENOUGH_FUNDS",
    "shippingMethod": {
      "courierOption": null,
      "methodType": "DIRECT",
      "pickupOption": null,
      "yandexDeliveryOption": null
    },
    "updated": "2025-01-01T00:00:00Z",
    "fiscalContact": "test@example.com"
  }
}
Предыдущая
/v1/orders/quickpay/cpqr
Следующая
/v1/orders/{order_id}/cancel