/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,
            "longitude": 0
        },
        "sw": {
            "latitude": 0,
            "longitude": 0
        }
    },
    "cart": {
        "cartId": "string",
        "coupons": [
            {
                "description": "string",
                "status": "VALID",
                "value": "string"
            }
        ],
        "discounts": [
            {
                "amount": "123.45",
                "description": "string",
                "discountId": "string"
            }
        ],
        "externalId": "string",
        "items": [
            {
                "description": "string",
                "discountedUnitPrice": "123.45",
                "measurements": {
                    "height": 0,
                    "length": 0,
                    "weight": 0,
                    "width": 0
                },
                "productId": "string",
                "quantity": {
                    "available": "123.45",
                    "count": "123.45",
                    "label": "string"
                },
                "receipt": {
                    "agent": {
                        "agentType": 1,
                        "operation": "string",
                        "paymentsOperator": {
                            "phones": [
                                "string"
                            ]
                        },
                        "phones": [
                            "string"
                        ],
                        "transferOperator": {
                            "address": "string",
                            "inn": "string",
                            "name": "string",
                            "phones": [
                                "string"
                            ]
                        }
                    },
                    "excise": "123.45",
                    "markQuantity": {
                        "denominator": 0,
                        "numerator": 0
                    },
                    "measure": 0,
                    "paymentMethodType": 1,
                    "paymentSubjectType": 1,
                    "productCode": "string",
                    "supplier": {
                        "inn": "string",
                        "name": "string",
                        "phones": [
                            "string"
                        ]
                    },
                    "tax": 1,
                    "title": "string"
                },
                "subtotal": "123.45",
                "title": "string",
                "total": "123.45",
                "type": "PHYSICAL",
                "unitPrice": "123.45"
            }
        ],
        "measurements": {
            "height": 0,
            "length": 0,
            "weight": 0,
            "width": 0
        },
        "total": {
            "amount": "123.45",
            "label": "string"
        }
    },
    "currencyCode": "string",
    "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
    "metadata": "string"
}

Name	Type	Description
boundingBox*	BoundingBox	Границы области на карте
cart*	CartWithoutFinalPrice	Корзина c ценами, размером и весом товаров
currencyCode*	string
merchantId*	string<uuid>
metadata	string

BoundingBox

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

Name	Type	Description
ne*	Location	Правый верхний угол (северо-восток)
sw*	Location	Левый нижний угол (юго-запад)

CartWithoutFinalPrice

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

Name	Type	Description
cartId	string	Внутренний идентификатор корзины Яндекс Пэй. Бэкенд магазина должен использовать этот параметр как идентификатор корзины покупателя и как ключ идемпотентности для запроса `/order/create`. Если бэкенд магазина получает повторный запрос `/order/create`, то необходимо вернуть уже созданный номер заказа. На одну корзину (`cartId`) бэкенд магазина может создать не больше одного заказа (`orderId`).
coupons	Coupon[]	Купоны, применённые к корзине
discounts	Discount[]	Скидки, применённые к корзине
externalId	string	Переданный продавцом идентификатор корзины
items	CartItemWithoutFinalPrice[]
measurements	Measurements	Размеры и вес товара. Обязательно для товара типа `PHYSICAL`
total	CartTotal	Итоговая стоимость корзины, которая пойдет в оплату

Location

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

Name	Type	Description
latitude*	number<float>
longitude*	number<float>

Coupon

Name	Type	Description
description	string	Описание. Например, "Скидка 3%"
status	string	Enum: `VALID`, `INVALID`, `EXPIRED`, `null`
value*	string	Код купона

Discount

Name	Type	Description
amount*	string<double>	Сумма скидки Example: `123.45`
description*	string	Текстовое описание
discountId*	string	Идентификатор скидки в системе мерчанта

CartItemWithoutFinalPrice

Name	Type	Description
description	string	Описание товара
discountedUnitPrice	string<double>	Цена за единицу товара с учётом скидок на позицию Example: `123.45`
measurements	Measurements	Размеры и вес товара. Обязательно для товара типа `PHYSICAL`
productId*	string	Id товара в системе продавца. В параметрах запроса каждый идентификатор товара `productId` должен быть уникальным
quantity*	ItemQuantity	Количество товара в заказе
receipt	ItemReceipt	Данные для формирования чека
subtotal	string<double>	Суммарная цена за позицию без учета скидок Example: `123.45`
title	string	Наименование товара
total	string<double>	Суммарная цена за позицию с учётом скидок на позицию Example: `123.45`
type	string	Тип товара. Важен для интеграции с доставками Enum: `PHYSICAL`, `DIGITAL`, `UNSPECIFIED` Default: `UNSPECIFIED`
unitPrice	string<double>	Полная цена за единицу товара без учетка скидки Example: `123.45`

Measurements

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

Name	Type	Description
height*	number<float>	Высота, в метрах
length*	number<float>	Длина, в метрах
weight*	number<float>	Вес, в килограммах
width*	number<float>	Ширина, в метрах

CartTotal

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

Name	Type	Description
amount*	string<double>	Стоимость корзины с учетом всех скидок, и без учета доставки Example: `123.45`
label	string

ItemQuantity

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

Name	Type	Description
available	string<double>	Максимально доступное количество товара Example: `123.45`
count*	string<double>	Количество товара в заказе Example: `123.45`
label	string	Название единиц измерения, например "кг" или "шт"

ItemReceipt

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

Name	Type	Description
agent	Agent
excise	string<double>	Не должно содержать больше двух знаков после запятой. Например: 1.12, 5.1, 10, 11.00 . Example: `123.45`
markQuantity	MarkQuantity
measure	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	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `null`
paymentSubjectType	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	string<base64>	Код товара (base64 кодированный массив от 1 до 32 байт)
supplier	Supplier
tax*	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`
title	string

Agent

Name	Type	Description
agentType*	integer	Описание значений: Ссылка Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	string
paymentsOperator	PaymentsOperator
phones	string[]
transferOperator	TransferOperator

MarkQuantity

Name	Type	Description
denominator*	integer<int32>
numerator*	integer<int32>

Supplier

Name	Type	Description
inn	string
name	string
phones	string[]

PaymentsOperator

Name	Type	Description
phones	string[]

TransferOperator

Name	Type	Description
address	string
inn	string
name	string
phones	string[]

Responses

200 OK

success

Body

application/json

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

Name	Type	Description
data*	MerchantPickupOptionsResponseData
status*	string

MerchantPickupOptionsResponseData

Name	Type	Description
pickupOptions*	PickupOption[]	если methodType == PICKUP

PickupOption

если methodType == PICKUP

Name	Type	Description
address*	string	Адрес в виде строки
allowedPaymentMethods	string[]	Индивидуальные методы оплаты для выбранного способа самовывоза. Доступные методы оплаты заказа при выбранном способе самовывоза. Этот параметр нужно использовать, если нужно ограничить методы оплаты, указанные в `availablePaymentMethods`. Если параметр не указан, то используются все методы оплаты, перечисленные в `availablePaymentMethods`. Enum: `CARD`, `SPLIT`, `CASH_ON_DELIVERY`, `CARD_ON_DELIVERY`
amount	string<double>	Стоимость доставки в точку Example: `123.45`
description	string	Дополнительное описание
fromDate	string<date>	YYYY-MM-DD. Ближайшая возможная дата доставки
location*	Location	Левый нижний угол (юго-запад)
phones	string[]	Телефоны для связи
pickupPointId*	string	Уникальный id точки самовывоза в системе продавца
provider	string	Тип точки вывоза. Enum: `YANDEX_MARKET`, `BOXBERRY`, `CDEK`, `IN_STORE`, `RUSSIAN_POST`, `PICKPOINT`, `DPD`
receipt	ItemReceipt	Данные для формирования чека
schedule	PickupSchedule[]	График работы точки
storagePeriod	integer<int32>	Опционально. Срок хранения товара в точке самовывоза в днях
title*	string	Название точки самовывоза
toDate	string<date>	YYYY-MM-DD. Самая поздняя дата доставки

PickupSchedule

Name	Type	Description
fromTime*	string	HH:mm, "08:00"
label*	string	Например, "пн-пт"
toTime*	string	HH:mm, "20:00"

400 Bad Request

bad request

Body

application/json

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

Name	Type	Description
reason	string
reasonCode*	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`
status	string	Default: `fail`

/v1/pickup-options

RequestRequest

BodyBody

BoundingBoxBoundingBox

CartWithoutFinalPriceCartWithoutFinalPrice

LocationLocation

CouponCoupon

DiscountDiscount

CartItemWithoutFinalPriceCartItemWithoutFinalPrice

MeasurementsMeasurements

CartTotalCartTotal

ItemQuantityItemQuantity

ItemReceiptItemReceipt

AgentAgent

MarkQuantityMarkQuantity

SupplierSupplier

PaymentsOperatorPaymentsOperator

TransferOperatorTransferOperator

ResponsesResponses

200 OK200 OK

BodyBody

MerchantPickupOptionsResponseDataMerchantPickupOptionsResponseData

PickupOptionPickupOption

PickupSchedulePickupSchedule

400 Bad Request400 Bad Request

BodyBody

Была ли статья полезна?

Request

Body

BoundingBox

CartWithoutFinalPrice

Location

Coupon

Discount

CartItemWithoutFinalPrice

Measurements

CartTotal

ItemQuantity

ItemReceipt

Agent

MarkQuantity

Supplier

PaymentsOperator

TransferOperator

Responses

200 OK

Body

MerchantPickupOptionsResponseData

PickupOption

PickupSchedule

400 Bad Request

Body