/v1/orders/{order_id} - order

Body

application/json

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

Name	Description
code	Type: unknown Default: `200`
data	Type: OrderResponseData Example { "delivery": { "actualPrice": "123.45", "created": "2025-01-01T00:00:00Z", "price": "123.45", "status": "NEW", "updated": "2025-01-01T00:00:00Z" }, "operations": [ { "amount": "123.45", "approvalCode": "example", "created": "2025-01-01T00:00:00Z", "externalOperationId": "example", "operationId": "123e4567-e89b-12d3-a456-426614174000", "operationType": "AUTHORIZE", "orderId": "example", "params": {}, "reason": "example", "status": "PENDING", "updated": "2025-01-01T00:00:00Z" } ], "order": { "cart": { "cartId": "example", "coupons": [ {} ], "discounts": [ {} ], "externalId": "example", "items": [ {} ], "measurements": { "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }, "total": null }, "created": "2025-01-01T00:00:00Z", "currencyCode": "RUB", "isPrepayment": false, "merchantId": "123e4567-e89b-12d3-a456-426614174000", "metadata": "example", "orderAmount": "123.45", "orderId": "example", "paymentMethod": { "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "CARD" }, "paymentStatus": "PENDING", "paymentUrl": "example", "reason": "example", "shippingMethod": { "courierOption": null, "methodType": "DIRECT", "pickupOption": null, "yandexDeliveryOption": null }, "updated": "2025-01-01T00:00:00Z" } }
status	Type: string Default: `success` Const: `success`

Delivery

Name	Description
price	Type: string<double> Delivery cost for the customer Example: `123.45`
actualPrice	Type: string<double> Delivery cost for the merchant Example: `123.45`
created	Type: string<date-time> Date and time when the delivery was created (ISO 8601) Example: `2025-01-01T00:00:00Z`
status	Type: string Delivery status Default: `NEW` Enum: `NEW`, `ESTIMATING`, `EXPIRED`, `READY_FOR_APPROVAL`, `COLLECTING`, `PREPARING`, `DELIVERING`, `DELIVERED`, `RETURNING`, `RETURNED`, `FAILED`, `CANCELLED`
updated	Type: string<date-time> Date and time when the delivery was updated (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

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

OrderResponseOperation

Name	Description
amount	Type: string<double> Transaction amount in a fiat currency Example: `123.45`
operationId	Type: string<uuid> Max length: `2048` Example: `123e4567-e89b-12d3-a456-426614174000`
operationType	Type: string Enum: `AUTHORIZE`, `BIND_CARD`, `REFUND`, `CAPTURE`, `VOID`, `RECURRING`, `PREPAYMENT`, `SUBMIT`
orderId	Type: string Max length: `2048` Example: `example`
approvalCode	Type: string Code of transaction confirmation received from the processing center. Example: `example`
created	Type: string<date-time> Date and time when the operation was created (ISO 8601) Example: `2025-01-01T00:00:00Z`
externalOperationId	Type: string Operation ID on the merchant side Max length: `2048` Example: `example`
params	Type: object Example `{}`
reason	Type: string Error cause Max length: `2048` Example: `example`
status	Type: string Default: `PENDING` Enum: `PENDING`, `SUCCESS`, `FAIL`
updated	Type: string<date-time> Date and time when the operation was updated (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

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

Coupon

Name	Description
value	Type: string Coupon code Max length: `2048` Example: `example`
description	Type: string Description For example, "3% discount" Max length: `2048` Example: `example`
status	Type: string Enum: `VALID`, `INVALID`, `EXPIRED`, `null` Example: `VALID`

Example

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

Discount

Name	Description
amount	Type: string<double> Discount amount Example: `123.45`
description	Type: string Text description Max length: `2048` Example: `example`
discountId	Type: string Discount ID in the merchant system Max length: `2048` 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" Max length: `2048` 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 Max length: `2048` Example: `example`
inn	Type: string Max length: `2048` Example: `example`
name	Type: string Max length: `2048` Example: `example`
phones	Type: string[] Example `[ "example" ]`

Example

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

Agent

Name	Description
agentType	Type: integer Agent type by taxable object. See values Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	Type: string Max length: `2048` Example: `example`
paymentsOperator	Type: PaymentsOperator Example `{ "phones": [ "example" ] }`
phones	Type: string[] Example `[ "example" ]`
transferOperator	Type: TransferOperator Example `{ "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] }`

Example

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

MarkQuantity

Name	Description
denominator	Type: integer
numerator	Type: integer

Example

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

Supplier

Name	Description
inn	Type: string Max length: `2048` Example: `example`
name	Type: string Max length: `2048` Example: `example`
phones	Type: string[] Example `[ "example" ]`

Example

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

ItemReceipt

Name	Description
tax	Type: integer 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 Max length: `2048` Example: `example`

Example

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

CartItem

Name	Description
productId	Type: string Product ID in the merchant system Make sure that each `productId` in the request parameters is unique. Max length: `2048` Example: `example`
quantity	All of 1 type Type: 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 Max length: `2048` 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": [ "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" } Data for receipt generation 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" }
subtotal	Type: string<double> Total price per item without discount Example: `123.45`
title	Type: string Product name Max length: `2048` Example: `example`
total	Type: string<double> Total 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": {
        "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"
  },
  "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" Max length: `2048` 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": { "agentType": 1, "operation": "example", "paymentsOperator": {}, "phones": [ null ], "transferOperator": {} }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ null ] }, "tax": 1, "title": "example" }, "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`). Max length: `2048` 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 Max length: `2048` Example: `example`
measurements	Type: Measurements Example `{ "height": 0.5, "length": 0.5, "weight": 0.5, "width": 0.5 }`
total	All of 1 type Type: CartTotal Example `{ "amount": "123.45", "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": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "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 Max length: `2048` Example: `example`
cardNetwork	Type: string Payment system Enum: `AMEX`, `DISCOVER`, `JCB`, `MASTERCARD`, `MAESTRO`, `VISAELECTRON`, `VISA`, `MIR`, `UNIONPAY`, `UZCARD`, `HUMOCARD`, `UNKNOWN`, `UNDEFINED`, `null` Example: `AMEX`

Example

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

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 Max length: `2048` Example: `example`
title	Type: string Delivery method name. Shown to the user in the option list Max length: `2048` 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": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }
timeIntervals	All of 1 type Type: FlexibleTimeIntervals Example `{ "grid": { "duration": "example", "end": "example", "start": "example", "step": "example" }, "type": "GRID", "values": [ { "end": "example", "start": "example" } ] }` 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": {
        "phones": [
          "example"
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          "example"
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "timeIntervals": {
    "grid": {
      "duration": "example",
      "end": "example",
      "start": "example",
      "step": "example"
    },
    "type": "GRID",
    "values": [
      null
    ]
  },
  "title": "example",
  "toDate": "2025-01-01",
  "toTime": "example",
  "type": "PLAIN"
}

Location

Name	Description
latitude	Type: number
longitude	Type: number

Example

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

PickupSchedule

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

Example

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

PickupOption

Name	Description
address	Type: string Address in string format Max length: `2048` Example: `example`
location	Type: Location Example `{ "latitude": 0.5, "longitude": 0.5 }`
pickupPointId	Type: string Unique pickup point ID in the merchant's system Max length: `2048` Example: `example`
title	Type: string Pickup point's name Max length: `2048` 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 Max length: `2048` 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": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }
schedule	Type: PickupSchedule[] 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": {
        "phones": [
          "example"
        ]
      },
      "phones": [
        "example"
      ],
      "transferOperator": {
        "address": "example",
        "inn": "example",
        "name": "example",
        "phones": [
          "example"
        ]
      }
    },
    "excise": "123.45",
    "markQuantity": {
      "denominator": 0,
      "numerator": 0
    },
    "measure": 0,
    "paymentMethodType": 1,
    "paymentSubjectType": 1,
    "productCode": "example",
    "supplier": {
      "inn": "example",
      "name": "example",
      "phones": [
        "example"
      ]
    },
    "tax": 1,
    "title": "example"
  },
  "schedule": [
    {
      "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 Max length: `2048` Example: `example`
yandexDeliveryOptionId	Type: string ID of the Yandex Delivery offer Max length: `2048` 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": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }
toDatetime	Type: string<date-time> Example: `2025-01-01T00:00:00Z`

Example

{
  "allowedPaymentMethods": [
    "CARD"
  ],
  "amount": "123.45",
  "category": "EXPRESS",
  "fromDatetime": "2025-01-01T00:00:00Z",
  "receipt": {
    "agent": {
      "agentType": 1,
      "operation": "example",
      "paymentsOperator": {
        "phones": [
          "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"
  },
  "title": "example",
  "toDatetime": "2025-01-01T00:00:00Z",
  "yandexDeliveryOptionId": "example"
}

ShippingMethod

Name	Description
methodType	Type: string Enum: `DIRECT`, `PICKUP`, `COURIER`, `YANDEX_DELIVERY`
courierOption	All of 1 type Type: CourierOption Example { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "courierOptionId": "example", "customerChoice": { "date": "2025-01-01", "time": { "end": "example", "start": "example" } }, "fromDate": "2025-01-01", "fromTime": "example", "provider": "BOXBERRY", "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }, "timeIntervals": { "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": { "end": "example", "start": "example" } }, "fromDate": "2025-01-01", "fromTime": "example", "provider": "BOXBERRY", "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ null ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ null ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }, "timeIntervals": { "grid": null, "type": "GRID", "values": [ null ] }, "title": "example", "toDate": "2025-01-01", "toTime": "example", "type": "PLAIN" }
pickupOption	All of 1 type Type: PickupOption Example { "address": "example", "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "description": "example", "fromDate": "2025-01-01", "location": { "latitude": 0.5, "longitude": 0.5 }, "phones": [ "example" ], "pickupPointId": "example", "provider": "YANDEX_MARKET", "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "example" ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ "example" ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }, "schedule": [ { "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": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ null ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ null ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }, "schedule": [ { "fromTime": "example", "label": "example", "toTime": "example" } ], "storagePeriod": 0, "title": "example", "toDate": "2025-01-01" }
yandexDeliveryOption	All of 1 type Type: YandexDeliveryOption Example { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "fromDatetime": "2025-01-01T00:00:00Z", "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ "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" }, "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": { "agentType": 1, "operation": "example", "paymentsOperator": { "phones": [ null ] }, "phones": [ "example" ], "transferOperator": { "address": "example", "inn": "example", "name": "example", "phones": [ null ] } }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ "example" ] }, "tax": 1, "title": "example" }, "title": "example", "toDatetime": "2025-01-01T00:00:00Z", "yandexDeliveryOptionId": "example" }

Example

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

Order

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 }, "pointsAmount": "123.45", "productId": "example", "quantity": { "available": "123.45", "count": "123.45", "label": "example" }, "receipt": { "agent": {}, "excise": "123.45", "markQuantity": {}, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": {}, "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, "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": null }
currencyCode	Type: string Three-letter code of the order currency code (ISO 4217) Const: `RUB` Max length: `2048` Example: `example`
created	Type: string<date-time> Date and time when the order was created (ISO 8601) Example: `2025-01-01T00:00:00Z`
isPrepayment	Type: boolean Flag indicating if the "deferred payment" flow is used for the order Default: `false`
merchantId	Type: string<uuid> Max length: `2048` Example: `123e4567-e89b-12d3-a456-426614174000`
metadata	Type: string Arbitrary data transmitted at button initialization Max length: `2048` Example: `example`
orderAmount	Type: string<double> Total cost of the order to be paid, including refunds, delivery costs, discounts, and promo codes Example: `123.45`
orderId	Type: string ID assigned to the existing order on the merchant side and transmitted at button initialization Max length: `2048` 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" }`
paymentStatus	Type: string Enum: `PENDING`, `AUTHORIZED`, `CAPTURED`, `VOIDED`, `REFUNDED`, `CONFIRMED`, `PARTIALLY_REFUNDED`, `FAILED`, `null` Example: `PENDING`
paymentUrl	Type: string Link to paying for the order Max length: `2048` Example: `example`
reason	Type: string reason (applicable to the VOIDED/FAILED statuses) Max length: `2048` Example: `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": {} }, "fromDate": "2025-01-01", "fromTime": "example", "provider": "BOXBERRY", "receipt": { "agent": { "agentType": 1, "operation": "example", "paymentsOperator": {}, "phones": [ null ], "transferOperator": {} }, "excise": "123.45", "markQuantity": { "denominator": 0, "numerator": 0 }, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": { "inn": "example", "name": "example", "phones": [ null ] }, "tax": 1, "title": "example" }, "timeIntervals": { "grid": null, "type": "GRID", "values": [ null ] }, "title": "example", "toDate": "2025-01-01", "toTime": "example", "type": "PLAIN" }, "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": { "agent": {}, "excise": "123.45", "markQuantity": {}, "measure": 0, "paymentMethodType": 1, "paymentSubjectType": 1, "productCode": "example", "supplier": {}, "tax": 1, "title": "example" }, "timeIntervals": null, "title": "example", "toDate": "2025-01-01", "toTime": "example", "type": "PLAIN" }, "methodType": "DIRECT", "pickupOption": { "address": "example", "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "description": "example", "fromDate": "2025-01-01", "location": { "latitude": 0.5, "longitude": 0.5 }, "phones": [ "example" ], "pickupPointId": "example", "provider": "YANDEX_MARKET", "receipt": null, "schedule": [ {} ], "storagePeriod": 0, "title": "example", "toDate": "2025-01-01" }, "yandexDeliveryOption": { "allowedPaymentMethods": [ "CARD" ], "amount": "123.45", "category": "EXPRESS", "fromDatetime": "2025-01-01T00:00:00Z", "receipt": null, "title": "example", "toDatetime": "2025-01-01T00:00:00Z", "yandexDeliveryOptionId": "example" } }
updated	Type: string<date-time> Date and time when the order was updated (ISO 8601) Example: `2025-01-01T00:00:00Z`

Example

{
  "cart": {
    "cartId": "example",
    "coupons": [
      {
        "description": "example",
        "status": "VALID",
        "value": "example"
      }
    ],
    "discounts": [
      {
        "amount": "123.45",
        "description": "example",
        "discountId": "example"
      }
    ],
    "externalId": "example",
    "items": [
      {
        "description": "example",
        "discountedUnitPrice": "123.45",
        "finalPrice": "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": null
  },
  "created": "2025-01-01T00:00:00Z",
  "currencyCode": "RUB",
  "isPrepayment": false,
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": "example",
  "orderAmount": "123.45",
  "orderId": "example",
  "paymentMethod": {
    "cardLast4": "example",
    "cardNetwork": "AMEX",
    "methodType": "CARD"
  },
  "paymentStatus": "PENDING",
  "paymentUrl": "example",
  "reason": "example",
  "shippingMethod": {
    "courierOption": {
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "courierOptionId": "example",
      "customerChoice": null,
      "fromDate": "2025-01-01",
      "fromTime": "example",
      "provider": "BOXBERRY",
      "receipt": {},
      "timeIntervals": null,
      "title": "example",
      "toDate": "2025-01-01",
      "toTime": "example",
      "type": "PLAIN"
    },
    "methodType": "DIRECT",
    "pickupOption": {
      "address": "example",
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "description": "example",
      "fromDate": "2025-01-01",
      "location": {},
      "phones": [
        null
      ],
      "pickupPointId": "example",
      "provider": "YANDEX_MARKET",
      "receipt": null,
      "schedule": [
        null
      ],
      "storagePeriod": 0,
      "title": "example",
      "toDate": "2025-01-01"
    },
    "yandexDeliveryOption": {
      "allowedPaymentMethods": [
        null
      ],
      "amount": "123.45",
      "category": "EXPRESS",
      "fromDatetime": "2025-01-01T00:00:00Z",
      "receipt": null,
      "title": "example",
      "toDatetime": "2025-01-01T00:00:00Z",
      "yandexDeliveryOptionId": "example"
    }
  },
  "updated": "2025-01-01T00:00:00Z"
}

OrderResponseData

Name	Description
delivery	Type: Delivery Example `{ "actualPrice": "123.45", "created": "2025-01-01T00:00:00Z", "price": "123.45", "status": "NEW", "updated": "2025-01-01T00:00:00Z" }`
operations	Type: OrderResponseOperation[] Example `[ { "amount": "123.45", "approvalCode": "example", "created": "2025-01-01T00:00:00Z", "externalOperationId": "example", "operationId": "123e4567-e89b-12d3-a456-426614174000", "operationType": "AUTHORIZE", "orderId": "example", "params": {}, "reason": "example", "status": "PENDING", "updated": "2025-01-01T00:00:00Z" } ]`
order	Type: Order 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, "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": null }, "created": "2025-01-01T00:00:00Z", "currencyCode": "RUB", "isPrepayment": false, "merchantId": "123e4567-e89b-12d3-a456-426614174000", "metadata": "example", "orderAmount": "123.45", "orderId": "example", "paymentMethod": { "cardLast4": "example", "cardNetwork": "AMEX", "methodType": "CARD" }, "paymentStatus": "PENDING", "paymentUrl": "example", "reason": "example", "shippingMethod": { "courierOption": { "allowedPaymentMethods": [ null ], "amount": "123.45", "category": "EXPRESS", "courierOptionId": "example", "customerChoice": null, "fromDate": "2025-01-01", "fromTime": "example", "provider": "BOXBERRY", "receipt": {}, "timeIntervals": null, "title": "example", "toDate": "2025-01-01", "toTime": "example", "type": "PLAIN" }, "methodType": "DIRECT", "pickupOption": { "address": "example", "allowedPaymentMethods": [ null ], "amount": "123.45", "description": "example", "fromDate": "2025-01-01", "location": {}, "phones": [ null ], "pickupPointId": "example", "provider": "YANDEX_MARKET", "receipt": null, "schedule": [ null ], "storagePeriod": 0, "title": "example", "toDate": "2025-01-01" }, "yandexDeliveryOption": { "allowedPaymentMethods": [ null ], "amount": "123.45", "category": "EXPRESS", "fromDatetime": "2025-01-01T00:00:00Z", "receipt": null, "title": "example", "toDatetime": "2025-01-01T00:00:00Z", "yandexDeliveryOptionId": "example" } }, "updated": "2025-01-01T00:00:00Z" }

Example

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

/v1/orders/

Request

Path parameters

Responses

200 OK

Body

Delivery

OrderResponseOperation

Coupon

Discount

Measurements

ItemQuantity

PaymentsOperator

TransferOperator

Agent

MarkQuantity

Supplier

ItemReceipt

CartItem

CartTotal

Cart

PaymentMethod

TimeInterval

FlexibleCustomerChoice

FlexibleTimeIntervalsGridDescriptor

FlexibleTimeIntervals

CourierOption

Location

PickupSchedule

PickupOption

YandexDeliveryOption

ShippingMethod

Order

OrderResponseData

Was the article helpful?