/v1/order/create

Request for validation or creation of an order on the merchant side.

In the request parameters, it passes a cart with items and their prices, selected delivery method, and the total order cost (orderAmount). The merchant checks that the prices and items in the cart are correct.

If the cart is correct, the merchant reserves the items for 30 minutes and responds with the success code to the Yandex Pay backend. Within 30 minutes, the Yandex Pay backend should send a notification about the payment status. The merchant can also poll the order status by the order details handle in the Yandex Pay API.

If the cart is correct, the merchant reserves the items for 30 minutes and responds by the success code with the order ID. If the merchant doesn't get the notification about the change in the order payment status within 30 minutes, you need to get the order details synchronously before releasing the items.

Warning

Only after receiving the FAILED payment status, the merchant can release the items and mark the order as canceled.

If the merchant receives code 4xx in response, the validation of the order is considered unsuccessful, the order won't be paid, and there won't be any repeat attempts to check the order. In the case of response 5xx, the request is repeated.

Request

POST

https://example.merchant.ru/v1/order/create

Production

POST

https://sandbox.example.merchant.ru/v1/order/create

Sandbox

Body

application/json

{
  "billingContact": {
    "email": "example",
    "firstName": "example",
    "lastName": "example",
    "phone": "example",
    "phoneAdditionalCode": "example",
    "secondName": "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",
        "finalPrice": "123.45",
        "measurements": null,
        "productId": "example",
        "quantity": null,
        "receipt": null,
        "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": "RUB",
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": "example",
  "orderAmount": "123.45",
  "orderId": "example",
  "paymentMethod": {
    "cardLast4": "example",
    "cardNetwork": "AMEX",
    "methodType": "CARD"
  },
  "shippingAddress": {
    "addressLine": "example",
    "building": "example",
    "comment": "example",
    "country": "example",
    "district": "example",
    "entrance": "example",
    "floor": "example",
    "intercom": "example",
    "locale": "example",
    "locality": "example",
    "location": {
      "latitude": 0.5,
      "longitude": 0.5
    },
    "region": "example",
    "room": "example",
    "street": "example",
    "zip": "example"
  },
  "shippingContact": null,
  "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": null,
      "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"
    }
  }
}

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", "finalPrice": "123.45", "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "productId": "example", "quantity": { "available": "123.45", "count": "123.45", "label": "example" }, "receipt": { "agent": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": null, "tax": 1, "title": "example" }, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": null } 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", "finalPrice": "123.45", "measurements": null, "productId": "example", "quantity": null, "receipt": null, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": null }
currencyCode	Type: string Three-letter code of the order currency code (ISO 4217) Const: `RUB` Example: `example`
billingContact	Type: Contact Example `{ "email": "example", "firstName": "example", "lastName": "example", "phone": "example", "phoneAdditionalCode": "example", "secondName": "example" }`
merchantId	Type: string<uuid> Example: `123e4567-e89b-12d3-a456-426614174000`
metadata	Type: string Arbitrary data transmitted at button initialization 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 ID assigned to the existing order on the merchant side and transmitted at button initialization Example: `example`
paymentMethod	All of 1 type Type: PaymentMethod Example `{ "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "CARD" }` Selected payment method Example `{ "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "CARD" }`
shippingAddress	All of 1 type Type: Address Example `{ "addressLine": "example", "building": "example", "comment": "example", "country": "example", "district": "example", "entrance": "example", "floor": "example", "intercom": "example", "locale": "example", "locality": "example", "location": { "latitude": 0.5, "longitude": 0.5 }, "region": "example", "room": "example", "street": "example", "zip": "example" }` Delivery address is available if the COURIER method is selected Example `{ "addressLine": "example", "building": "example", "comment": "example", "country": "example", "district": "example", "entrance": "example", "floor": "example", "intercom": "example", "locale": "example", "locality": "example", "location": { "latitude": 0.5, "longitude": 0.5 }, "region": "example", "room": "example", "street": "example", "zip": "example" }`
shippingContact	Type: Contact Example `{ "email": "example", "firstName": "example", "lastName": "example", "phone": "example", "phoneAdditionalCode": "example", "secondName": "example" }`
shippingMethod	All of 1 type Type: ShippingMethod Example { "courierOption": { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "courierOptionId": "example", "customerChoice": { "date": "2025-01-01", "time": null }, "fromDate": "2025-01-01", "fromTime": "example", "provider": "BOXBERRY", "receipt": { "agent": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": null, "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" } } Selected delivery method. 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" } }

Contact

Name	Description
email	Type: string Example: `example`
firstName	Type: string Example: `example`
lastName	Type: string Example: `example`
phone	Type: string Example: `example`
phoneAdditionalCode	Type: string Example: `example`
secondName	Type: string Example: `example`

Example

{
  "email": "example",
  "firstName": "example",
  "lastName": "example",
  "phone": "example",
  "phoneAdditionalCode": "example",
  "secondName": "example"
}

Coupon

Name	Description
value	Type: string Coupon code Example: `example`
description	Type: string Description For example, "3% discount" 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> Discount amount Example: `123.45`
description	Type: string Text description Example: `example`
discountId	Type: string Discount ID in the merchant system Example: `example`

Example

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

Measurements

Name	Description
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
}

ItemQuantity

Name	Description
count	Type: string<double> Product quantity in the order Example: `123.45`
available	Type: string<double> Maximum available product quantity Example: `123.45`
label	Type: string Name of measurement units, for example, "kg" or "pcs" Example: `example`

Example

{
  "available": "123.45",
  "count": "123.45",
  "label": "example"
}

PaymentsOperator

Name	Description
phones	Type: string[] Example `[ "example" ]`

Example

{
  "phones": [
    "example"
  ]
}

TransferOperator

Name	Description
address	Type: string Example: `example`
inn	Type: string Example: `example`
name	Type: string Example: `example`
phones	Type: string[] Example `[ "example" ]`

Example

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

Agent

Name	Description
agentType	Type: integer Agent type by taxable object. See values Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	Type: string 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 Example: `example`
name	Type: string Example: `example`
phones	Type: string[] Example `[ "example" ]`

Example

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

ItemReceipt

Name	Description
tax	Type: integer Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`
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> It shouldn't include more than two decimal digits. For example: 1.12, 5.1, 10, 11.00 . Example: `123.45`
markQuantity	Type: MarkQuantity Example `{ "denominator": 0, "numerator": 0 }`
measure	Type: integer Value description: Link 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 Value description: Link Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `null`
paymentSubjectType	Type: integer Value description: Link 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> Product code (a base64-encoded array of 1 to 32 bytes) Example: `example`
supplier	Type: Supplier Example `{ "inn": "example", "name": "example", "phones": [ "example" ] }`
title	Type: string 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 Product ID in the merchant system Make sure that each `productId` in the request parameters is unique. Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45", "label": "example" }` Product quantity in the order Example `{ "available": "123.45", "count": "123.45", "label": "example" }`
description	Type: string Product description Example: `example`
discountedUnitPrice	Type: string<double> Price per product unit with discount per item Example: `123.45`
finalPrice	Type: string<double> Price per product unit with all discounts per item and on the cart Example: `123.45`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Product dimensions and weight. Required for the `PHYSICAL` product Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
receipt	All of 1 type Type: ItemReceipt Example `{ "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" }` Data for receipt generation Example `{ "agent": { "agentType": 1, "operation": "example", "paymentsOperator": null, "phones": [ "example" ], "transferOperator": 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" }`
subtotal	Type: string<double> Total price per item without discount Example: `123.45`
title	Type: string Product name Example: `example`
total	Type: string<double> Total price per item with item discount Example: `123.45`
type	Type: string Product type. Important for integrating with delivery services Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Total price per product unit without discount Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "finalPrice": "123.45",
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45",
    "label": "example"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": null,
      "phones": [
        null
      ],
      "transferOperator": null
    },
    "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"
  },
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Cart cost with all discounts

Example: 123.45

label

Type: string

Name of measurement units, for example, "kg" or "pcs"

Example: example

Example

{
  "amount": "123.45",
  "label": "example"
}

Cart

Name	Description
items	Type: CartItem[] Cart item Example [ { "description": "example", "discountedUnitPrice": "123.45", "finalPrice": "123.45", "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "productId": "example", "quantity": { "available": "123.45", "count": "123.45", "label": "example" }, "receipt": { "agent": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": null, "tax": 1, "title": "example" }, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]
cartId	Type: string The internal ID of the Yandex Pay cart. The store's backend must use this parameter as the ID of the customer cart and the idempotency key for the `/order/create` request. If the store's backend receives a repeat `/order/create` request, return the existing order ID. The store's backend can create no more than one order (`orderId`) per cart (`cartId`). Example: `example`
coupons	Type: Coupon[] Coupons applied to the cart Example `[ { "description": "example", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Discounts applied to the cart Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Cart ID passed by the merchant 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", "label": "example" }` Total cart cost that the customer is to pay 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",
      "finalPrice": "123.45",
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45",
        "label": "example"
      },
      "receipt": {
        "agent": null,
        "excise": "123.45",
        "markQuantity": null,
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": null,
        "tax": 1,
        "title": "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`
cardLast4	Type: string 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": "CARD"
}

Location

Name	Description
latitude	Type: number
longitude	Type: number

Example

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

Address

Name	Description
building	Type: string Example: `example`
country	Type: string Example: `example`
addressLine	Type: string Full address Example: `example`
comment	Type: string Example: `example`
district	Type: string Example: `example`
entrance	Type: string Example: `example`
floor	Type: string Example: `example`
intercom	Type: string Example: `example`
locale	Type: string Example: `example`
locality	Type: string Example: `example`
location	Type: Location Example `{ "latitude": 0.5, "longitude": 0.5 }`
region	Type: string Example: `example`
room	Type: string Example: `example`
street	Type: string Example: `example`
zip	Type: string Example: `example`

Example

{
  "addressLine": "example",
  "building": "example",
  "comment": "example",
  "country": "example",
  "district": "example",
  "entrance": "example",
  "floor": "example",
  "intercom": "example",
  "locale": "example",
  "locality": "example",
  "location": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "region": "example",
  "room": "example",
  "street": "example",
  "zip": "example"
}

TimeInterval

Name

Description

end

Type: string

Interval end time

Example: example

start

Type: string

Interval start time

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 Duration of each interval Example: `example`
end	Type: string Maximum start time for the latest interval Example: `example`
start	Type: string Start time for the very first interval Example: `example`
step	Type: string Difference in time between the starts of two neighboring intervals Example: `example`

Example

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

FlexibleTimeIntervals

Name	Description
type	Type: string For the `GRID` type, fill in the `grid` field. If the `VALUES` type is specified, set the `values` field. Enum: `GRID`, `VALUES`
grid	All of 1 type Type: FlexibleTimeIntervalsGridDescriptor Example `{ "duration": "example", "end": "example", "start": "example", "step": "example" }` Encodes the intervals as a grid. Use this format if you want to set more than 20 delivery intervals. Example: `{"start": "09:00", "end": "21:00", "duration": "00:20", "step": "01:00"}` is treated as a set of intervals: `[{"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[] Set the list of intervals directly. Suitable for a small number of delivery intervals. The maximum recommended number of intervals is 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> Delivery cost Example: `123.45`
category	Type: string Enum: `EXPRESS`, `TODAY`, `STANDARD`
courierOptionId	Type: string ID of the selected delivery method in the merchant system Example: `example`
title	Type: string Delivery method name. Shown to the user in the option list Example: `example`
allowedPaymentMethods	Type: string[] Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used. Example `[ "CARD" ]`
customerChoice	All of 1 type Type: FlexibleCustomerChoice Example `{ "date": "2025-01-01", "time": { "end": "example", "start": "example" } }` Date and interval selected by the user. Only for `type: FLEXIBLE` Example `{ "date": "2025-01-01", "time": { "end": "example", "start": "example" } }`
fromDate	Type: string<date> Closest delivery date for `type: PLAIN`. Start of the interval of the delivery date selection for `type: FLEXIBLE` Example: `2025-01-01`
fromTime	Type: string Start of the delivery time interval. Only for `type: PLAIN` Example: `example`
provider	Type: string Delivery service type. 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	Type: ItemReceipt Example `{ "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	All of 1 type Type: FlexibleTimeIntervals Example `{ "grid": { "duration": "example", "end": "example", "start": "example", "step": "example" }, "type": "GRID", "values": [ { "end": "example", "start": "example" } ] }` Codes the intervals of the delivery time available for selection. Only for `type: FLEXIBLE` Example `{ "grid": { "duration": "example", "end": "example", "start": "example", "step": "example" }, "type": "GRID", "values": [ { "end": "example", "start": "example" } ] }`
toDate	Type: string<date> Latest delivery date for `type: PLAIN`. End of the interval of the delivery date selection for `type: FLEXIBLE` Example: `2025-01-01`
toTime	Type: string End of the delivery time interval. Only for `type: PLAIN` Example: `example`
type	Type: string Option type. For `FLEXIBLE` delivery options, the user can select the desirable date and interval: The delivery date is selected by the user in the interval `[fromDate, toDate]` To give the user an option to select an interval within a day, fill out `timeIntervals` No such choice is provided for `PLAIN` options. 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": null,
      "phones": [
        "example"
      ],
      "transferOperator": 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"
}

PickupSchedule

Name	Description
fromTime	Type: string HH:mm, "08:00" Example: `example`
label	Type: string For example, "Mon-Fri" Example: `example`
toTime	Type: string HH:mm, "20:00" Example: `example`

Example

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

PickupOption

Name	Description
address	Type: string Address in string format Example: `example`
location	Type: Location Example `{ "latitude": 0.5, "longitude": 0.5 }`
pickupPointId	Type: string Unique pickup point ID in the merchant's system Example: `example`
title	Type: string Pickup point's name Example: `example`
allowedPaymentMethods	Type: string[] Individual payment methods for the selected pickup method. Methods that can be used to pay for the order with the selected pickup method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used. Example `[ "CARD" ]`
amount	Type: string<double> Cost of delivery to the location Example: `123.45`
description	Type: string Additional description Example: `example`
fromDate	Type: string<date> YYYY-MM-DD. Closest possible delivery date Example: `2025-01-01`
phones	Type: string[] Contact phone numbers Example `[ "example" ]`
provider	Type: string Pickup point's type. Enum: `YANDEX_MARKET`, `BOXBERRY`, `CDEK`, `IN_STORE`, `RUSSIAN_POST`, `PICKPOINT`, `DPD`
receipt	Type: ItemReceipt Example `{ "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	Type: PickupSchedule[] Pickup point's schedule Example `[ { "fromTime": "example", "label": "example", "toTime": "example" } ]`
storagePeriod	Type: integer Optional. Storage period at the pickup point, in days.
toDate	Type: string<date> YYYY-MM-DD. Latest delivery date 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": null,
      "phones": [
        "example"
      ],
      "transferOperator": 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> Delivery cost Example: `123.45`
category	Type: string Enum: `EXPRESS`, `TODAY`, `STANDARD`
title	Type: string Delivery method name. Shown to the user in the option list Example: `example`
yandexDeliveryOptionId	Type: string ID of the Yandex Delivery offer Example: `example`
allowedPaymentMethods	Type: string[] Individual payment methods for the delivery method. Use this parameter if you want to restrict the payment methods specified in `availablePaymentMethods`. If the parameter is omitted, all the payment methods listed in `availablePaymentMethods` are used. Example `[ "CARD" ]`
fromDatetime	Type: string<date-time> Example: `2025-01-01T00:00:00Z`
receipt	Type: ItemReceipt Example `{ "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" }`
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": null,
      "phones": [
        "example"
      ],
      "transferOperator": 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": null, "phones": [ null ], "transferOperator": null }, "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": { "duration": "example", "end": "example", "start": "example", "step": "example" }, "type": "GRID", "values": [ null ] }, "title": "example", "toDate": "2025-01-01", "toTime": "example", "type": "PLAIN" } if methodType == COURIER Example { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "courierOptionId": "example", "customerChoice": { "date": "2025-01-01", "time": null }, "fromDate": "2025-01-01", "fromTime": "example", "provider": "BOXBERRY", "receipt": { "agent": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": 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": null, "phones": [ null ], "transferOperator": null }, "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" } if 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": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": 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": null, "phones": [ null ], "transferOperator": null }, "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" } if methodType == YANDEX_DELIVERY Example `{ "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "fromDatetime": "2025-01-01T00:00:00Z", "receipt": { "agent": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": 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": null
    },
    "fromDate": "2025-01-01",
    "fromTime": "example",
    "provider": "BOXBERRY",
    "receipt": {
      "agent": null,
      "excise": "123.45",
      "markQuantity": null,
      "measure": 0,
      "paymentMethodType": 1,
      "paymentSubjectType": 1,
      "productCode": "example",
      "supplier": null,
      "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"
  }
}

Responses

200 OK

success

Body

application/json

{
  "data": {
    "metadata": "example",
    "orderId": "example",
    "redirectUrls": {
      "onAbort": "example",
      "onError": "example",
      "onSuccess": "example"
    },
    "ttl": null
  },
  "status": "example"
}

Name

Description

data

Type: MerchantCreateOrderResponse

Example

{
  "metadata": "example",
  "orderId": "example",
  "redirectUrls": {
    "onAbort": "example",
    "onError": "example",
    "onSuccess": "example"
  },
  "ttl": null
}

status

Type: string

Example: example

CartItem

Name	Description
productId	Type: string Product ID in the merchant system Make sure that each `productId` in the request parameters is unique. Example: `example`
quantity	All of 1 type Type: ItemQuantity Example `{ "available": "123.45", "count": "123.45", "label": "example" }` Product quantity in the order Example `{ "available": "123.45", "count": "123.45", "label": "example" }`
description	Type: string Product description Example: `example`
discountedUnitPrice	Type: string<double> Price per product unit with discount per item Example: `123.45`
finalPrice	Type: string<double> Price per product unit with all discounts per item and on the cart Example: `123.45`
measurements	All of 1 type Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }` Product dimensions and weight. Required for the `PHYSICAL` product Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
pointsAmount	Type: string<double> Number of Plus points Read-only field. Input values will be ignored. Example: `123.45`
receipt	All of 1 type Type: ItemReceipt Example `{ "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" }` Data for receipt generation Example `{ "agent": { "agentType": 1, "operation": "example", "paymentsOperator": null, "phones": [ "example" ], "transferOperator": 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" }`
subtotal	Type: string<double> Total price per item without discount Example: `123.45`
title	Type: string Product name Example: `example`
total	Type: string<double> Total price per item with item discount Example: `123.45`
type	Type: string Product type. Important for integrating with delivery services Default: `UNSPECIFIED` Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED`
unitPrice	Type: string<double> Total price per product unit without discount Example: `123.45`

Example

{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "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",
    "label": "example"
  },
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": null,
      "phones": [
        null
      ],
      "transferOperator": null
    },
    "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"
  },
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name	Description
amount	Type: string<double> Cart cost with all discounts Example: `123.45`
label	Type: string Name of measurement units, for example, "kg" or "pcs" Example: `example`
pointsAmount	Type: string<double> Number of Plus points Read-only field. Input values will be ignored. Example: `123.45`

Example

{
  "amount": "123.45",
  "label": "example",
  "pointsAmount": "123.45"
}

Cart

Name	Description
items	Type: CartItem[] Cart item Example [ { "description": "example", "discountedUnitPrice": "123.45", "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", "label": "example" }, "receipt": { "agent": null, "excise": "123.45", "markQuantity": null, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": null, "tax": 1, "title": "example" }, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ]
cartId	Type: string The internal ID of the Yandex Pay cart. The store's backend must use this parameter as the ID of the customer cart and the idempotency key for the `/order/create` request. If the store's backend receives a repeat `/order/create` request, return the existing order ID. The store's backend can create no more than one order (`orderId`) per cart (`cartId`). Example: `example`
coupons	Type: Coupon[] Coupons applied to the cart Example `[ { "description": "example", "status": "VALID", "value": "example" } ]`
discounts	Type: Discount[] Discounts applied to the cart Example `[ { "amount": "123.45", "description": "example", "discountId": "example" } ]`
externalId	Type: string Cart ID passed by the merchant 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", "label": "example", "pointsAmount": "123.45" }` Total cart cost that the customer is to pay 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",
      "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",
        "label": "example"
      },
      "receipt": {
        "agent": null,
        "excise": "123.45",
        "markQuantity": null,
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": null,
        "tax": 1,
        "title": "example"
      },
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

MerchantRedirectUrls

Name	Description
onError	Type: string The field is required for online stores only. A link to redirect the user in case of a payment error or TTL expiry for a payment link Example: `example`
onSuccess	Type: string The field is required for online stores only. Link to redirect the user on payment success. Example: `example`
onAbort	Type: string Link to redirect the user on payment cancellation. Payment can be canceled by the user in the payment form. Example: `example`

Example

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

MerchantCreateOrderResponse

Name	Description
orderId	Type: string ID assigned to the created order on the merchant side Example: `example`
metadata	Type: string Example: `example`
redirectUrls	Type: MerchantRedirectUrls Example `{ "onAbort": "example", "onError": "example", "onSuccess": "example" }`
ttl	Type: integer Order's time to live (in seconds) Default: `null`

Example

{
  "metadata": "example",
  "orderId": "example",
  "redirectUrls": {
    "onAbort": "example",
    "onError": "example",
    "onSuccess": "example"
  },
  "ttl": null
}

400 Bad Request

bad request

Body

application/json

{
  "reason": "example",
  "reasonCode": "FORBIDDEN",
  "status": "fail"
}

Name	Description
reasonCode	Type: string Enum: `FORBIDDEN`, `ITEM_NOT_FOUND`, `ORDER_NOT_FOUND`, `ORDER_AMOUNT_MISMATCH`, `ORDER_DETAILS_MISMATCH`, `OUT_OF_INVENTORY`, `PICKUP_POINT_NOT_FOUND`, `SHIPPING_DETAILS_MISMATCH`, `OTHER`, `UNAUTHORIZED`, `TOKEN_EXPIRED`, `CONFLICT`
reason	Type: string Example: `example`
status	Type: string Default: `fail`

/v1/order/create

Request

Body

Contact

Coupon

Discount

Measurements

ItemQuantity

PaymentsOperator

TransferOperator

Agent

MarkQuantity

Supplier

ItemReceipt

CartItem

CartTotal

Cart

PaymentMethod

Location

Address

TimeInterval

FlexibleCustomerChoice

FlexibleTimeIntervalsGridDescriptor

FlexibleTimeIntervals

CourierOption

PickupSchedule

PickupOption

YandexDeliveryOption

ShippingMethod

Responses

200 OK

Body

CartItem

CartTotal

Cart

MerchantRedirectUrls

MerchantCreateOrderResponse

400 Bad Request

Body

Was the article helpful?