/v1/order/render ⦸

Warning

This endpoint has been deprecated. Avoid using it.

/v1/order/render

Request data to display the cart.

In the request parameters, transmit the product IDs and product quantities or the order number. The response returns the parameters and content for the Yandex Pay form.

Product IDs and quantities are provided as the input.
You can pass arbitrary data in the metadata field from the merchant's frontend to the store's backend. The method is invoked when adding or removing items from the cart, selecting a delivery address and delivery method, or applying promo codes. The merchant needs to double check items in the order and fill out detailed information about products, delivery methods, and promo codes, recalculate product totals and order totals.

Detailed information on the order and products is expected in response:

Available types of payment methods and delivery methods is in availablePaymentMethods, shipping.availableMethods, respectively
Additional user data needed for ordering is in requiredFields
The cost and name of each product. The maximum available quantity of product (optional)
The information about discounts applied to the cart is in discounts

Request

POST

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

Production

POST

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

Sandbox

Body

application/json

{
  "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",
        "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",
  "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"
  },
  "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: CartWithoutFinalPrice 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", "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 with prices, dimensions, and weight of the products 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", "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`
merchantId	Type: string<uuid> Example: `123e4567-e89b-12d3-a456-426614174000`
metadata	Type: string Arbitrary data transmitted at button initialization Example: `example`
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" }`
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" } }

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

CartItemWithoutFinalPrice

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

CartWithoutFinalPrice

Name	Description
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`
items	Type: CartItemWithoutFinalPrice[] Example [ { "description": "example", "discountedUnitPrice": "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	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",
      "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": {
    "availablePaymentMethods": [
      "CARD"
    ],
    "cart": {
      "coupons": [
        {}
      ],
      "discounts": [
        {}
      ],
      "externalId": "example",
      "items": [
        {}
      ],
      "measurements": null,
      "total": null
    },
    "currencyCode": "RUB",
    "enableCommentField": true,
    "enableCoupons": true,
    "metadata": "example",
    "orderAmount": "123.45",
    "requiredFields": {
      "billingContact": null,
      "shippingContact": null
    },
    "shipping": {
      "availableCourierOptions": [
        {}
      ],
      "availableMethods": [
        "DIRECT"
      ],
      "courierOptionsError": "WRONG_ADDRESS",
      "yandexDelivery": null
    }
  },
  "status": "example"
}

Name

Description

data

Type: MerchantRenderOrderResponseData

Example

{
  "availablePaymentMethods": [
    "CARD"
  ],
  "cart": {
    "coupons": [
      {
        "description": "example",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "measurements": null,
        "pointsAmount": "123.45",
        "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": {
      "amount": "123.45",
      "label": "example",
      "pointsAmount": "123.45"
    }
  },
  "currencyCode": "RUB",
  "enableCommentField": true,
  "enableCoupons": true,
  "metadata": "example",
  "orderAmount": "123.45",
  "requiredFields": {
    "billingContact": {
      "email": true
    },
    "shippingContact": {
      "email": true,
      "name": true,
      "phone": true
    }
  },
  "shipping": {
    "availableCourierOptions": [
      {
        "allowedPaymentMethods": [
          null
        ],
        "amount": "123.45",
        "category": "EXPRESS",
        "courierOptionId": "example",
        "fromDate": "2025-01-01",
        "fromTime": "example",
        "provider": "BOXBERRY",
        "receipt": null,
        "timeIntervals": null,
        "title": "example",
        "toDate": "2025-01-01",
        "toTime": "example",
        "type": "PLAIN"
      }
    ],
    "availableMethods": [
      "DIRECT"
    ],
    "courierOptionsError": "WRONG_ADDRESS",
    "yandexDelivery": {
      "warehouse": null
    }
  }
}

status

Type: string

Example: example

CartItemWithoutFinalPrice

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

CartWithoutFinalPrice

Name	Description
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`
items	Type: CartItemWithoutFinalPrice[] Example [ { "description": "example", "discountedUnitPrice": "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	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",
      "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
}

RenderedCartItem

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" }`
total	Type: string<double> Total price per item with item discount Example: `123.45`
description	Type: string Product description Example: `example`
discountedUnitPrice	Type: string<double> Price per product unit with discount per item 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`
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",
  "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"
}

RenderedCart

Name	Description
items	Type: RenderedCartItem[] Cart items that the customer pays for. Example [ { "description": "example", "discountedUnitPrice": "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" } ]
total	All of 1 type Type: CartTotal Example `{ "amount": "123.45", "label": "example", "pointsAmount": "123.45" }` Final order cost. Example `{ "amount": "123.45", "label": "example", "pointsAmount": "123.45" }`
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 }`

Example

{
  "coupons": [
    {
      "description": "example",
      "status": "VALID",
      "value": "example"
    }
  ],
  "discounts": [
    {
      "amount": "123.45",
      "description": "example",
      "discountId": "example"
    }
  ],
  "externalId": "example",
  "items": [
    {
      "description": "example",
      "discountedUnitPrice": "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": {
    "amount": "123.45",
    "label": "example",
    "pointsAmount": "123.45"
  }
}

BillingContactFields

Name	Description
email	Type: boolean

Example

{
  "email": true
}

ContactFields

Name	Description
email	Type: boolean
name	Type: boolean
phone	Type: boolean

Example

{
  "email": true,
  "name": true,
  "phone": true
}

RequiredFields

Name	Description
billingContact	Type: BillingContactFields Example `{ "email": true }`
shippingContact	Type: ContactFields Example `{ "email": true, "name": true, "phone": true }`

Example

{
  "billingContact": {
    "email": true
  },
  "shippingContact": {
    "email": true,
    "name": true,
    "phone": true
  }
}

CourierOption1

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" ]`
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",
  "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": [
      {
        "end": "example",
        "start": "example"
      }
    ]
  },
  "title": "example",
  "toDate": "2025-01-01",
  "toTime": "example",
  "type": "PLAIN"
}

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

WeeklySchedule

Name	Description
fri	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Friday Example `{ "end": "example", "start": "example" }`
mon	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Monday Example `{ "end": "example", "start": "example" }`
sat	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Saturday Example `{ "end": "example", "start": "example" }`
sun	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Sunday Example `{ "end": "example", "start": "example" }`
thu	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Thursday Example `{ "end": "example", "start": "example" }`
tue	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Tuesday Example `{ "end": "example", "start": "example" }`
wed	All of 1 type Type: TimeInterval Example `{ "end": "example", "start": "example" }` Wednesday Example `{ "end": "example", "start": "example" }`

Example

{
  "fri": {
    "end": "example",
    "start": "example"
  },
  "mon": null,
  "sat": null,
  "sun": null,
  "thu": null,
  "tue": null,
  "wed": null
}

Schedule

Name

Description

tzoffset

Type: integer

Time zone offset from UTC, in minutes. For example, 180 for Moscow (UTC+3)

Min value: -720

Max value: 840

weekly

All of 1 type

Type: WeeklySchedule

Example

{
  "fri": {
    "end": "example",
    "start": "example"
  },
  "mon": null,
  "sat": null,
  "sun": null,
  "thu": null,
  "tue": null,
  "wed": null
}

Weekly working schedule

Example

{
  "fri": {
    "end": "example",
    "start": "example"
  },
  "mon": null,
  "sat": null,
  "sun": null,
  "thu": null,
  "tue": null,
  "wed": null
}

custom

Type: object | null

[additional]

All of 1 type

Type: TimeInterval1

Example

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

Example

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

Redefined schedule for specific dates. The keys are dates in the format "YYYY-MM-DD", and the values are objects {"start": string, "end": string} or null for non-business days

Example

{}

Example

{
  "custom": {},
  "tzoffset": -720,
  "weekly": {
    "fri": {
      "end": "example",
      "start": "example"
    },
    "mon": null,
    "sat": null,
    "sun": null,
    "thu": null,
    "tue": null,
    "wed": null
  }
}

ShippingWarehouse

Name	Description
address	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" }`
contact	Type: Contact Example `{ "email": "example", "firstName": "example", "lastName": "example", "phone": "example", "phoneAdditionalCode": "example", "secondName": "example" }`
emergencyContact	Type: Contact Example `{ "email": "example", "firstName": "example", "lastName": "example", "phone": "example", "phoneAdditionalCode": "example", "secondName": "example" }`
schedule	All of 1 type Type: Schedule Example `{ "custom": {}, "tzoffset": -720, "weekly": { "fri": { "end": "example", "start": "example" }, "mon": null, "sat": null, "sun": null, "thu": null, "tue": null, "wed": null } }` Working schedule Example `{ "custom": {}, "tzoffset": -720, "weekly": { "fri": null, "mon": null, "sat": null, "sun": null, "thu": null, "tue": null, "wed": null } }`

Example

{
  "address": {
    "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"
  },
  "contact": {
    "email": "example",
    "firstName": "example",
    "lastName": "example",
    "phone": "example",
    "phoneAdditionalCode": "example",
    "secondName": "example"
  },
  "emergencyContact": null,
  "schedule": {
    "custom": {},
    "tzoffset": -720,
    "weekly": {
      "fri": null,
      "mon": null,
      "sat": null,
      "sun": null,
      "thu": null,
      "tue": null,
      "wed": null
    }
  }
}

YandexDeliveryShippingParams

Name

Description

warehouse

Type: ShippingWarehouse

Example

{
  "address": {
    "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"
  },
  "contact": {
    "email": "example",
    "firstName": "example",
    "lastName": "example",
    "phone": "example",
    "phoneAdditionalCode": "example",
    "secondName": "example"
  },
  "emergencyContact": null,
  "schedule": {
    "custom": {},
    "tzoffset": -720,
    "weekly": {
      "fri": null,
      "mon": null,
      "sat": null,
      "sun": null,
      "thu": null,
      "tue": null,
      "wed": null
    }
  }
}

Example

{
  "warehouse": {
    "address": {
      "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"
    },
    "contact": {
      "email": "example",
      "firstName": "example",
      "lastName": "example",
      "phone": "example",
      "phoneAdditionalCode": "example",
      "secondName": "example"
    },
    "emergencyContact": null,
    "schedule": {
      "custom": {},
      "tzoffset": -720,
      "weekly": null
    }
  }
}

ShippingOptions

Name	Description
availableMethods	Type: string[] Example `[ "DIRECT" ]`
availableCourierOptions	Type: CourierOption1[] Available delivery options (if the request includes an address) Example [ { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "courierOptionId": "example", "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": [ {} ] }, "title": "example", "toDate": "2025-01-01", "toTime": "example", "type": "PLAIN" } ]
courierOptionsError	Type: string Error of identifying a delivery option. When this parameter is specified, an error description will be shown in the user interface. Enum: `WRONG_ADDRESS`, `DELIVERY_NOT_AVAILABLE_FOR_ADDRESS`, `null` Example: `WRONG_ADDRESS`
yandexDelivery	Type: YandexDeliveryShippingParams Example { "warehouse": { "address": { "addressLine": "example", "building": "example", "comment": "example", "country": "example", "district": "example", "entrance": "example", "floor": "example", "intercom": "example", "locale": "example", "locality": "example", "location": null, "region": "example", "room": "example", "street": "example", "zip": "example" }, "contact": { "email": "example", "firstName": "example", "lastName": "example", "phone": "example", "phoneAdditionalCode": "example", "secondName": "example" }, "emergencyContact": null, "schedule": { "custom": {}, "tzoffset": -720, "weekly": null } } }

Example

{
  "availableCourierOptions": [
    {
      "allowedPaymentMethods": [
        "CARD"
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "courierOptionId": "example",
      "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"
    }
  ],
  "availableMethods": [
    "DIRECT"
  ],
  "courierOptionsError": "WRONG_ADDRESS",
  "yandexDelivery": {
    "warehouse": {
      "address": {
        "addressLine": "example",
        "building": "example",
        "comment": "example",
        "country": "example",
        "district": "example",
        "entrance": "example",
        "floor": "example",
        "intercom": "example",
        "locale": "example",
        "locality": "example",
        "location": null,
        "region": "example",
        "room": "example",
        "street": "example",
        "zip": "example"
      },
      "contact": {
        "email": "example",
        "firstName": "example",
        "lastName": "example",
        "phone": "example",
        "phoneAdditionalCode": "example",
        "secondName": "example"
      },
      "emergencyContact": null,
      "schedule": null
    }
  }
}

MerchantRenderOrderResponseData

Name	Description
cart	All of 1 type Type: RenderedCart Example { "coupons": [ { "description": "example", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "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": { "amount": "123.45", "label": "example", "pointsAmount": "123.45" } } Cart Example { "coupons": [ { "description": "example", "status": "VALID", "value": "example" } ], "discounts": [ { "amount": "123.45", "description": "example", "discountId": "example" } ], "externalId": "example", "items": [ { "description": "example", "discountedUnitPrice": "123.45", "measurements": null, "pointsAmount": "123.45", "productId": "example", "quantity": null, "receipt": null, "subtotal": "123.45", "title": "example", "total": "123.45", "type": "UNSPECIFIED", "unitPrice": "123.45" } ], "measurements": null, "total": { "amount": "123.45", "label": "example", "pointsAmount": "123.45" } }
currencyCode	Type: string Three-letter code of the order currency code (ISO 4217) Const: `RUB` Example: `example`
availablePaymentMethods	Type: string[] Payment methods available in the Yandex Pay payment form. Be sure to specify all the possible methods the user can choose both when paying online and when paying on delivery. If you are integrating payments only with one method (for example, Split), specify a single method (`["SPLIT"]`). Example `[ "CARD" ]`
enableCommentField	Type: boolean
enableCoupons	Type: boolean
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`
requiredFields	All of 1 type Type: RequiredFields Example `{ "billingContact": { "email": true }, "shippingContact": { "email": true, "name": true, "phone": true } }` User data needed to create an order Example `{ "billingContact": { "email": true }, "shippingContact": { "email": true, "name": true, "phone": true } }`
shipping	Type: ShippingOptions Example { "availableCourierOptions": [ { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "courierOptionId": "example", "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" } ], "availableMethods": [ "DIRECT" ], "courierOptionsError": "WRONG_ADDRESS", "yandexDelivery": { "warehouse": { "address": {}, "contact": {}, "emergencyContact": null, "schedule": null } } }

Example

{
  "availablePaymentMethods": [
    "CARD"
  ],
  "cart": {
    "coupons": [
      {
        "description": "example",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "measurements": null,
        "pointsAmount": "123.45",
        "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": {
      "amount": "123.45",
      "label": "example",
      "pointsAmount": "123.45"
    }
  },
  "currencyCode": "RUB",
  "enableCommentField": true,
  "enableCoupons": true,
  "metadata": "example",
  "orderAmount": "123.45",
  "requiredFields": {
    "billingContact": {
      "email": true
    },
    "shippingContact": {
      "email": true,
      "name": true,
      "phone": true
    }
  },
  "shipping": {
    "availableCourierOptions": [
      {
        "allowedPaymentMethods": [
          "CARD"
        ],
        "amount": "123.45",
        "category": "EXPRESS",
        "courierOptionId": "example",
        "fromDate": "2025-01-01",
        "fromTime": "example",
        "provider": "BOXBERRY",
        "receipt": null,
        "timeIntervals": null,
        "title": "example",
        "toDate": "2025-01-01",
        "toTime": "example",
        "type": "PLAIN"
      }
    ],
    "availableMethods": [
      "DIRECT"
    ],
    "courierOptionsError": "WRONG_ADDRESS",
    "yandexDelivery": {
      "warehouse": 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`

Was the article helpful?

/v1/webhook

/v1/order/create ⦸