/v1/pickup-options

Request to retrieve pickup points.

A request to retrieve available pickup points based on the items in the cart.

Request

POST

https://example.merchant.ru/v1/pickup-options

Production

POST

https://sandbox.example.merchant.ru/v1/pickup-options

Sandbox

Body

application/json

{
  "boundingBox": {
    "ne": {
      "latitude": 0.5,
      "longitude": 0.5
    },
    "sw": null
  },
  "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": "example",
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": "example"
}

Name	Description
boundingBox	All of 1 type Type: BoundingBox Example `{ "ne": { "latitude": 0.5, "longitude": 0.5 }, "sw": null }` Area borders on the map Example `{ "ne": { "latitude": 0.5, "longitude": 0.5 }, "sw": null }`
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": {}, "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 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 Example: `example`
merchantId	Type: string<uuid> Example: `123e4567-e89b-12d3-a456-426614174000`
metadata	Type: string Example: `example`

Location

Name	Description
latitude	Type: number
longitude	Type: number

Example

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

BoundingBox

Name	Description
ne	All of 1 type Type: Location Example `{ "latitude": 0.5, "longitude": 0.5 }` Upper-right corner (Northeast) Example `{ "latitude": 0.5, "longitude": 0.5 }`
sw	All of 1 type Type: Location Example `{ "latitude": 0.5, "longitude": 0.5 }` Lower-left corner (Southwest) Example `{ "latitude": 0.5, "longitude": 0.5 }`

Example

{
  "ne": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "sw": null
}

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": [ "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 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": {
        "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"

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": { "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" } ]
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": {},
        "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
}

Responses

200 OK

success

Body

application/json

{
  "data": {
    "pickupOptions": [
      {
        "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": {},
          "excise": "123.45",
          "markQuantity": {},
          "measure": 0,
          "paymentMethodType": 1,
          "paymentSubjectType": 1,
          "productCode": "example",
          "supplier": {},
          "tax": 1,
          "title": "example"
        },
        "schedule": [
          {}
        ],
        "storagePeriod": 0,
        "title": "example",
        "toDate": "2025-01-01"
      }
    ]
  },
  "status": "example"
}

Name

Description

data

Type: MerchantPickupOptionsResponseData

Example

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

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": [ "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 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": {
        "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" 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": { "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" } ]
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": {},
        "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
}

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

MerchantPickupOptionsResponseData

Name

Description

pickupOptions

Type: PickupOption[]

Example

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

Example

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

400 Bad Request

bad request

Body

application/json

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

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

/v1/pickup-options

Request

Body

Location

BoundingBox

Coupon

Discount

Measurements

ItemQuantity

PaymentsOperator

TransferOperator

Agent

MarkQuantity

Supplier

ItemReceipt

CartItemWithoutFinalPrice

CartTotal

CartWithoutFinalPrice

Responses

200 OK

Body

CartItemWithoutFinalPrice

CartTotal

CartWithoutFinalPrice

PickupSchedule

PickupOption

MerchantPickupOptionsResponseData

400 Bad Request

Body

Was the article helpful?