|
data
|
Type: object
|
delivery
|
Type: object
|
price
|
Type: string<double>
Delivery cost for the customer
Example: 123.45
|
|
actualPrice
|
Type: string<double>
Delivery cost for the merchant
Example: 123.45
|
|
created
|
Type: string<date-time>
Date and time when the delivery was created (ISO 8601)
Example: 2025-01-01T00:00:00Z
|
|
status
|
Type: string
Delivery status
Default: NEW
Enum: NEW, ESTIMATING, EXPIRED, READY_FOR_APPROVAL, COLLECTING, PREPARING, DELIVERING, DELIVERED, RETURNING, RETURNED, FAILED, CANCELLED
|
|
updated
|
Type: string<date-time>
Date and time when the delivery was updated (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"
}
|
|
operations
|
Type: object[]
|
amount
|
Type: string<double>
Transaction amount in a fiat currency
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
Code of transaction confirmation received from the processing center.
Example: example
|
|
created
|
Type: string<date-time>
Date and time when the operation was created (ISO 8601)
Example: 2025-01-01T00:00:00Z
|
|
externalOperationId
|
Type: string
Operation ID on the merchant side
Max length: 2048
Example: example
|
|
params
|
Type: object
Example |
|
reason
|
Type: string
Error cause
Max length: 2048
Example: example
|
|
status
|
Type: string
Default: PENDING
Enum: PENDING, SUCCESS, FAIL
|
|
updated
|
Type: string<date-time>
Date and time when the operation was updated (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"
}
]
|
|
order
|
Type: object
|
cart
|
All of 1 type
-
Type: object
|
items
|
Type: object[]
|
productId
|
Type: string
Product ID in the merchant system. Make sure that each productId in the request parameters is unique.
Max length: 2048
Example: example
|
|
quantity
|
All of 1 type
-
Type: object
|
count
|
Type: string<double>
Product quantity in the order
Example: 123.45
|
|
available
|
Type: string<double>
Maximum available product quantity
Example: 123.45
|
Example
{
"available": "123.45",
"count": "123.45"
}
Product quantity in the order
Example
{
"available": "123.45",
"count": "123.45"
}
|
|
description
|
Type: string
Product description
Max length: 2048
Example: example
|
|
discountedUnitPrice
|
Type: string<double>
Price per product unit with discount per item
Example: 123.45
|
|
features
|
All of 1 type
-
Type: object
|
pointsDisabled
|
Type: boolean
Unavailable in Uzbekistan.
Default: false
|
|
tariffModifier
|
Type: string
Rate modifier used for fee calculation. Determines the rate to be applied when calculating the fee for handling a cart item.
Enum: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, null
Example: VERY_LOW
|
Example
{
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
}
Product promo parameters
Example
{
"pointsDisabled": false,
"tariffModifier": "VERY_LOW"
}
|
|
finalPrice
|
Type: string<double>
Unit price including all item-level and cart-level discounts
Example: 123.45
|
|
measurements
|
All of 1 type
-
Type: object
|
height
|
Type: number
Height, in meters
|
|
length
|
Type: number
Length, in meters
|
|
weight
|
Type: number
Weight, in kilograms
|
|
width
|
Type: number
Width, in meters
|
Example
{
"height": 0.5,
"length": 0.5,
"weight": 0.5,
"width": 0.5
}
Product dimensions and weight. Required for the PHYSICAL product type
Example
{
"height": 0.5,
"length": 0.5,
"weight": 0.5,
"width": 0.5
}
|
|
pointsAmount
|
Type: string<double>
Unavailable in Uzbekistan.
Example: 123.45
|
|
skuId
|
Type: string
Unique ID that describes a product range unit. Required when applying individual rates.
Max length: 2048
Example: example
|
|
subtotal
|
Type: string<double>
Total price per item without discount
Example: 123.45
|
|
title
|
Type: string
Product name
Max length: 2048
Example: example
|
|
total
|
Type: string<double>
Total item price including item-level discounts
Example: 123.45
|
|
type
|
Type: string
Product type. Important for integrating with delivery services
Default: UNSPECIFIED
Enum: PHYSICAL, DIGITAL, UNSPECIFIED
|
|
unitPrice
|
Type: string<double>
Full unit price excluding discounts
Example: 123.45
|
List of cart items
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"
},
"skuId": "example",
"subtotal": "123.45",
"title": "example",
"total": "123.45",
"type": "UNSPECIFIED",
"unitPrice": "123.45"
}
]
|
|
cartId
|
Type: string
Cart ID on the Yandex side
Max length: 2048
Example: example
|
|
coupons
|
Type: object[]
|
value
|
Type: string
Coupon code
Max length: 2048
Example: example
|
|
description
|
Type: string
Coupon description
Max length: 2048
Example: Скидка 3%
|
|
status
|
Type: string
Enum: VALID, INVALID, EXPIRED, null
Example: VALID
|
Coupons applied to the cart
Example
[
{
"description": "Скидка 3%",
"status": "VALID",
"value": "example"
}
]
|
|
discounts
|
Type: object[]
|
amount
|
Type: string<double>
Discount amount
Example: 123.45
|
|
description
|
Type: string
Text description
Max length: 2048
Example: example
|
|
discountId
|
Type: string
Discount identifier in the merchant system
Max length: 2048
Example: example
|
Discounts applied to the cart
Example
[
{
"amount": "123.45",
"description": "example",
"discountId": "example"
}
]
|
|
externalId
|
Type: string
Merchant-side cart identifier
Max length: 2048
Example: example
|
|
measurements
|
Type: object
|
height
|
Type: number
Height, in meters
|
|
length
|
Type: number
Length, in meters
|
|
weight
|
Type: number
Weight, in kilograms
|
|
width
|
Type: number
Width, in meters
|
Example
{
"height": 0.5,
"length": 0.5,
"weight": 0.5,
"width": 0.5
}
|
|
total
|
All of 1 type
-
Type: object
|
amount
|
Type: string<double>
Cart cost with all discounts
Example: 123.45
|
|
pointsAmount
|
Type: string<double>
Unavailable in Uzbekistan.
Example: 123.45
|
Example
{
"amount": "123.45",
"pointsAmount": "123.45"
}
Total cart cost that the customer is to pay
Default: null
|
Example
{
"cartId": "example",
"coupons": [
{
"description": "Скидка 3%",
"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"
},
"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
}
Cart
Example
{
"cartId": "example",
"coupons": [
{
"description": "Скидка 3%",
"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,
"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
}
|
|
currencyCode
|
Type: string
Three-letter code of the order currency code (ISO 4217)
Enum: RUB, UZS
Max length: 2048
|
|
coolingPeriodExpiresAt
|
Type: string<date-time>
Cooling-off period end date and time (ISO 8601)
Example: 2025-01-01T00:00:00Z
|
|
created
|
Type: string<date-time>
Date and time when the order was created (ISO 8601)
Example: 2025-01-01T00:00:00Z
|
|
isPrepayment
|
Type: boolean
Flag indicating whether to process the order using the "deferred payment" flow.
If set to true, deferred payment is enabled for the order.
Default: false
|
|
merchantId
|
Type: string<uuid>
Max length: 2048
Example: 123e4567-e89b-12d3-a456-426614174000
|
|
metadata
|
Type: string
Arbitrary data transmitted at button initialization
Max length: 2048
Example: example
|
|
orderAmount
|
Type: string<double>
Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes
Example: 123.45
|
|
orderId
|
Type: string
Merchant-side order ID that was passed in the /orders request.
Max length: 2048
Example: example
|
|
paymentMethod
|
Type: object
|
methodType
|
Type: string
Const: SPLIT
Example: example
|
|
cardLast4
|
Type: string
Max length: 2048
Example: example
|
|
cardNetwork
|
Type: string
Payment system
Enum: AMEX, DISCOVER, JCB, MASTERCARD, MAESTRO, VISAELECTRON, VISA, MIR, UNIONPAY, UZCARD, HUMOCARD, UNKNOWN, UNDEFINED, null
Example: AMEX
|
Example
{
"cardLast4": "example",
"cardNetwork": "AMEX",
"methodType": "SPLIT"
}
|
|
paymentStatus
|
Type: string
For more information, see Operation statuses.
Enum: PENDING, AUTHORIZED, CAPTURED, VOIDED, REFUNDED, CONFIRMED, PARTIALLY_REFUNDED, FAILED, null
Example: PENDING
|
|
paymentUrl
|
Type: string
Link to paying for the order
Max length: 2048
Example: example
|
|
reason
|
Type: string
Order cancellation reason. Applicable to the VOIDED and FAILED statuses.
Max length: 2048
Example: example
|
|
updated
|
Type: string<date-time>
Date and time when the order was updated (ISO 8601)
Example: 2025-01-01T00:00:00Z
|
Example
{
"cart": {
"cartId": "example",
"coupons": [
{
"description": "Скидка 3%",
"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,
"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-01-01T00:00:00Z",
"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": "SPLIT"
},
"paymentStatus": "PENDING",
"paymentUrl": "example",
"reason": "example",
"updated": "2025-01-01T00:00:00Z"
}
|
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-01-01T00:00:00Z",
"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": "SPLIT"
},
"paymentStatus": "PENDING",
"paymentUrl": "example",
"reason": "example",
"updated": "2025-01-01T00:00:00Z"
}
}
|