/v1/pickup-options

Запрос на получение точек самовывоза.

Запрос на получение доступных точек самовывоза по корзине товаров.

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",
        "features": null,
        "measurements": null,
        "productId": "example",
        "quantity": null,
        "receipt": null,
        "skuId": "example",
        "subtotal": "123.45",
        "title": "example",
        "total": "123.45",
        "type": "UNSPECIFIED",
        "unitPrice": "123.45"
      }
    ],
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "total": null
  },
  "currencyCode": "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
}

Границы области на карте

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",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

Корзина c ценами, размером и весом товаров

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",
      "features": null,
      "measurements": null,
      "productId": "example",
      "quantity": null,
      "receipt": null,
      "skuId": "example",
      "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
}

Правый верхний угол (северо-восток)

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

sw
All of 1 type

  • Type: Location

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

Левый нижний угол (юго-запад)

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

Coupon

Name

Description

value

Type: string

Код купона

Example: example

description

Type: string

Описание. Например, "Скидка 3%"

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>

Сумма скидки

Example: 123.45

description

Type: string

Текстовое описание

Example: example

discountId

Type: string

Идентификатор скидки в системе мерчанта

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

CartItemFeatures

Name

Description

pointsDisabled

Type: boolean

Не распределять баллы Плюса. Используется только при создании заказа. Если это поле не указано, то баллы будут распределены на товар

Default: false

tariffModifier

Type: string

Модификатор тарифа для расчета комиссии. Определяет, какой тариф будет применяться при расчете комиссии за обработку позиции в корзине.

Enum: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, null

Example: VERY_LOW
Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

Measurements

Name

Description

height

Type: number

Высота, в метрах

length

Type: number

Длина, в метрах

weight

Type: number

Вес, в килограммах

width

Type: number

Ширина, в метрах
Example
{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

ItemQuantity

Name

Description

count

Type: string<double>

Количество товара в заказе

Example: 123.45

available

Type: string<double>

Максимально доступное количество товара

Example: 123.45
Example
{
  "available": "123.45",
  "count": "123.45"
}

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

Признак агента по предмету расчёта. См. значения

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

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

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>

Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 .

Example: 123.45

markQuantity

Type: MarkQuantity

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

measure

Type: integer

Описание значений: Ссылка

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

Описание значений: Ссылка

Enum: 1, 2, 3, 4, 5, 6, 7, null

paymentSubjectType

Type: integer

Описание значений: Ссылка

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>

Код товара (base64 кодированный массив от 1 до 32 байт)

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

Id товара в системе продавца. В параметрах запроса каждый идентификатор товара productId должен быть уникальным

Example: example

quantity
All of 1 type

  • Type: ItemQuantity

    Example
    {
  "available": "123.45",
  "count": "123.45"
}

Количество товара в заказе

Example
{
  "available": "123.45",
  "count": "123.45"
}

description

Type: string

Описание товара

Example: example

discountedUnitPrice

Type: string<double>

Цена за единицу товара с учётом скидок на позицию

Example: 123.45

features
All of 1 type

  • Type: CartItemFeatures

    Example
    {
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

Промо параметры товара

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

measurements
All of 1 type

  • Type: Measurements

    Example
    {
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

Размеры и вес товара. Обязательно для товара типа PHYSICAL

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

Данные для формирования чека

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

skuId

Type: string

Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа.

Example: example

subtotal

Type: string<double>

Суммарная цена за позицию без учета скидок

Example: 123.45

title

Type: string

Наименование товара

Example: example

total

Type: string<double>

Суммарная цена за позицию с учётом скидок на позицию

Example: 123.45

type

Type: string

Тип товара. Важен для интеграции с доставками

Default: UNSPECIFIED

Enum: PHYSICAL, DIGITAL, UNSPECIFIED

unitPrice

Type: string<double>

Полная цена за единицу товара без учетка скидки

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "measurements": {
    "height": 0.5,
    "length": 0.5,
    "weight": 0.5,
    "width": 0.5
  },
  "productId": "example",
  "quantity": {
    "available": "123.45",
    "count": "123.45"
  },
  "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"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Стоимость корзины с учетом всех скидок.

Example: 123.45

externalAmount

Type: string<double>

Сумма внешнего покрытия (сертификаты, подарочные карты).

Example: 123.45
Example
{
  "amount": "123.45",
  "externalAmount": "123.45"
}

CartWithoutFinalPrice

Name

Description

cartId

Type: string

Внутренний идентификатор корзины Яндекс Пэй.

Бэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса /order/create. Если бэкенд магазина получает повторный запрос /order/create, то необходимо вернуть уже созданный номер заказа. На одну корзину (cartId) бэкенд магазина может создать не больше одного заказа (orderId).

Example: example

coupons

Type: Coupon[]

Купоны, применённые к корзине

Example
[
  {
    "description": "example",
    "status": "VALID",
    "value": "example"
  }
]

discounts

Type: Discount[]

Скидки, применённые к корзине

Example
[
  {
    "amount": "123.45",
    "description": "example",
    "discountId": "example"
  }
]

externalId

Type: string

Переданный продавцом идентификатор корзины

Example: example

items

Type: CartItemWithoutFinalPrice[]

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    },
    "measurements": {
      "height": 0.5,
      "length": 0.5,
      "weight": 0.5,
      "width": 0.5
    },
    "productId": "example",
    "quantity": {
      "available": "123.45",
      "count": "123.45"
    },
    "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"
    },
    "skuId": "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",
  "externalAmount": "123.45"
}

Итоговая стоимость корзины, которая пойдет в оплату

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",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "measurements": {
        "height": 0.5,
        "length": 0.5,
        "weight": 0.5,
        "width": 0.5
      },
      "productId": "example",
      "quantity": {
        "available": "123.45",
        "count": "123.45"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "example",
      "subtotal": "123.45",
      "title": "example",
      "total": "123.45",
      "type": "UNSPECIFIED",
      "unitPrice": "123.45"
    }
  ],
  "measurements": null,
  "total": null
}

Responses

200 OK

Вебхук успешно получен и обработан. Тело ответа может быть любым, рекомендуем отправить {"status": "success"}. При получении 200 Яндекс Пэй прекращает отправку повторных вебхуков.

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

Id товара в системе продавца. В параметрах запроса каждый идентификатор товара productId должен быть уникальным

Example: example

quantity
All of 1 type

  • Type: ItemQuantity

    Example
    {
  "available": "123.45",
  "count": "123.45"
}

Количество товара в заказе

Example
{
  "available": "123.45",
  "count": "123.45"
}

description

Type: string

Описание товара

Example: example

discountedUnitPrice

Type: string<double>

Цена за единицу товара с учётом скидок на позицию

Example: 123.45

features
All of 1 type

  • Type: CartItemFeatures

    Example
    {
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

Промо параметры товара

Example
{
  "pointsDisabled": false,
  "tariffModifier": "VERY_LOW"
}

measurements
All of 1 type

  • Type: Measurements

    Example
    {
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

Размеры и вес товара. Обязательно для товара типа PHYSICAL

Example
{
  "height": 0.5,
  "length": 0.5,
  "weight": 0.5,
  "width": 0.5
}

pointsAmount

Type: string<double>

Количество баллов Плюса

Поле только для чтения. Переданные значения будут проигнорированы.

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

Данные для формирования чека

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

skuId

Type: string

Уникальный id, который описывает единицу ассортимента. Необходим для применения индивидуального тарифа.

Example: example

subtotal

Type: string<double>

Суммарная цена за позицию без учета скидок

Example: 123.45

title

Type: string

Наименование товара

Example: example

total

Type: string<double>

Суммарная цена за позицию с учётом скидок на позицию

Example: 123.45

type

Type: string

Тип товара. Важен для интеграции с доставками

Default: UNSPECIFIED

Enum: PHYSICAL, DIGITAL, UNSPECIFIED

unitPrice

Type: string<double>

Полная цена за единицу товара без учетка скидки

Example: 123.45
Example
{
  "description": "example",
  "discountedUnitPrice": "123.45",
  "features": {
    "pointsDisabled": false,
    "tariffModifier": "VERY_LOW"
  },
  "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"
  },
  "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"
  },
  "skuId": "example",
  "subtotal": "123.45",
  "title": "example",
  "total": "123.45",
  "type": "UNSPECIFIED",
  "unitPrice": "123.45"
}

CartTotal

Name

Description

amount

Type: string<double>

Стоимость корзины с учетом всех скидок.

Example: 123.45

externalAmount

Type: string<double>

Сумма внешнего покрытия (сертификаты, подарочные карты).

Example: 123.45

pointsAmount

Type: string<double>

Количество баллов Плюса

Поле только для чтения. Переданные значения будут проигнорированы.

Example: 123.45
Example
{
  "amount": "123.45",
  "externalAmount": "123.45",
  "pointsAmount": "123.45"
}

CartWithoutFinalPrice

Name

Description

cartId

Type: string

Внутренний идентификатор корзины Яндекс Пэй.

Бэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса /order/create. Если бэкенд магазина получает повторный запрос /order/create, то необходимо вернуть уже созданный номер заказа. На одну корзину (cartId) бэкенд магазина может создать не больше одного заказа (orderId).

Example: example

coupons

Type: Coupon[]

Купоны, применённые к корзине

Example
[
  {
    "description": "example",
    "status": "VALID",
    "value": "example"
  }
]

discounts

Type: Discount[]

Скидки, применённые к корзине

Example
[
  {
    "amount": "123.45",
    "description": "example",
    "discountId": "example"
  }
]

externalId

Type: string

Переданный продавцом идентификатор корзины

Example: example

items

Type: CartItemWithoutFinalPrice[]

Example
[
  {
    "description": "example",
    "discountedUnitPrice": "123.45",
    "features": {
      "pointsDisabled": false,
      "tariffModifier": "VERY_LOW"
    },
    "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"
    },
    "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"
    },
    "skuId": "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",
  "externalAmount": "123.45",
  "pointsAmount": "123.45"
}

Итоговая стоимость корзины, которая пойдет в оплату

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",
      "features": {
        "pointsDisabled": false,
        "tariffModifier": "VERY_LOW"
      },
      "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"
      },
      "receipt": {
        "agent": {},
        "excise": "123.45",
        "markQuantity": {},
        "measure": 0,
        "paymentMethodType": 1,
        "paymentSubjectType": 1,
        "productCode": "example",
        "supplier": {},
        "tax": 1,
        "title": "example"
      },
      "skuId": "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

Например, "пн-пт"

Example: example

toTime

Type: string

HH:mm, "20:00"

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

PickupOption

Name

Description

address

Type: string

Адрес в виде строки

Example: example

location

Type: Location

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

pickupPointId

Type: string

Уникальный id точки самовывоза в системе продавца

Example: example

title

Type: string

Название точки самовывоза

Example: example

allowedPaymentMethods

Type: string[]

Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в availablePaymentMethods. Если параметр не указан, то используются все методы оплаты, перечисленные в availablePaymentMethods.

Example
[
  "CARD"
]

amount

Type: string<double>

Стоимость доставки в точку

Example: 123.45

description

Type: string

Дополнительное описание

Example: example

fromDate

Type: string<date>

YYYY-MM-DD. Ближайшая возможная дата доставки

Example: 2025-01-01

phones

Type: string[]

Телефоны для связи

Example
[
  "example"
]

provider

Type: string

Тип точки вывоза.

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[]

График работы точки

Example
[
  {
    "fromTime": "example",
    "label": "example",
    "toTime": "example"
  }
]

storagePeriod

Type: integer

Опционально. Срок хранения товара в точке самовывоза в днях

toDate

Type: string<date>

YYYY-MM-DD. Самая поздняя дата доставки

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

Ошибка обработки вебхука. При отсутствии ответа или любом статусе кроме 200 Яндекс Пэй генерирует новый JWT-токен и повторяет отправку вебхука:

  • первые 10 раз через 5 мс;
  • далее с экспоненциально возрастающим интервалом до 15 минут;
  • затем каждые 15 минут в течение 24 часов. Общее время повторных отправок — 24 часа. После этого вебхук считается недоставленным.

Body

application/json
{
  "reason": "example",
  "reasonCode": "FORBIDDEN",
  "status": "fail"
}

Name

Description

reasonCode

Type: string

Код ошибки:

  • FORBIDDEN — заказ существует, но был оплачен не через Яндекс Пэй;
  • ORDER_NOT_FOUND — заказ не найден в системе продавца;
  • ORDER_AMOUNT_MISMATCH — сумма заказа не совпадает с суммой в системе продавца;
  • ORDER_DETAILS_MISMATCH — детали заказа отличаются от данных в системе продавца;
  • OTHER — общая ошибка;
  • UNAUTHORIZED — не удалось проверить подпись JWT-токена;
  • TOKEN_EXPIRED — срок действия JWT-токена истек;
  • CONFLICT — данные в нотификации расходятся с состоянием заказа в системе продавца. Например, пришла нотификация об оплате для отмененного заказа.

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

No longer supported, please use an alternative and newer version.