/v1/pickup-option-details

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

По точке самовывоза (pickupPointId) и корзине товаров бэкенд магазина возвращает детальную информацию о точке самовывоза.

Request

POST

https://example.merchant.ru/v1/pickup-option-details

Production

POST

https://sandbox.example.merchant.ru/v1/pickup-option-details

Sandbox

Body

application/json

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

Name	Description
cart*	Type: CartWithoutFinalPrice Корзина c ценами, размером и весом товаров
currencyCode*	Type: string
merchantId*	Type: string<uuid>
pickupPointId*	Type: string
metadata	Type: string

CartWithoutFinalPrice

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

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

Coupon

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

Discount

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

CartItemWithoutFinalPrice

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

Measurements

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

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

CartTotal

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

Name

Description

amount*

Type: string<double>

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

Example: 123.45

label

Type: string

Название единиц измерения, например "кг" или "шт".

ItemQuantity

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

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

ItemReceipt

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

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

Agent

Name	Description
agentType*	Type: integer Признак агента по предмету расчёта. См. значения Enum: `1`, `2`, `3`, `4`, `5`, `6`, `7`
operation	Type: string
paymentsOperator	Type: PaymentsOperator
phones	Type: string[]
transferOperator	Type: TransferOperator

MarkQuantity

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

Supplier

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

PaymentsOperator

Name	Description
phones	Type: string[]

TransferOperator

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

Responses

200 OK

success

Body

application/json

{
    "data": {
        "pickupOption": {
            "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	Description
data*	Type: MerchantPickupOptionDetailsResponseData
status*	Type: string

MerchantPickupOptionDetailsResponseData

Name	Description
pickupOption*	Type: PickupOptionDetails

PickupOptionDetails

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

Location

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

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

PickupSchedule

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

400 Bad Request

bad request

Body

application/json

{
    "reason": "string",
    "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
status	Type: string Default: `fail`

/v1/pickup-option-details

RequestRequest

BodyBody

CartWithoutFinalPriceCartWithoutFinalPrice

CouponCoupon

DiscountDiscount

CartItemWithoutFinalPriceCartItemWithoutFinalPrice

MeasurementsMeasurements

CartTotalCartTotal

ItemQuantityItemQuantity

ItemReceiptItemReceipt

AgentAgent

MarkQuantityMarkQuantity

SupplierSupplier

PaymentsOperatorPaymentsOperator

TransferOperatorTransferOperator

ResponsesResponses

200 OK200 OK

BodyBody

MerchantPickupOptionDetailsResponseDataMerchantPickupOptionDetailsResponseData

PickupOptionDetailsPickupOptionDetails

LocationLocation

PickupSchedulePickupSchedule

400 Bad Request400 Bad Request

BodyBody

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

Request

Body

CartWithoutFinalPrice

Coupon

Discount

CartItemWithoutFinalPrice

Measurements

CartTotal

ItemQuantity

ItemReceipt

Agent

MarkQuantity

Supplier

PaymentsOperator

TransferOperator

Responses

200 OK

Body

MerchantPickupOptionDetailsResponseData

PickupOptionDetails

Location

PickupSchedule

400 Bad Request

Body