Получение точек ПВЗ

.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает список пунктов выдачи заказов.

Регулярно запрашивайте эту информацию, чтобы в системе магазина хранить актуальные данные. Например, раз в день.

⚙️ Лимит: 10 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/logistics-points

Path parameters

Name

Description

businessId

Type: integer

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer

Количество значений на одной странице.

Min value: 1

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Responses

200 OK

Информация о пунктах выдачи заказов.

Body

application/json
{
  "status": "OK",
  "result": {
    "logisticPoints": [
      {
        "logisticPointId": 1,
        "brand": "MARKET",
        "address": {},
        "workingSchedule": {},
        "deliveryRestrictions": {},
        "features": [
          null
        ],
        "paymentTypes": [
          null
        ],
        "storagePeriod": 0
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: GetLogisticsPointsDTO

    Информация о пунктах выдачи заказов.

    Example
    {
  "logisticPoints": [
    {
      "logisticPointId": 1,
      "brand": "MARKET",
      "address": {
        "fullAddress": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        },
        "regionId": 0,
        "city": "example",
        "street": "example",
        "house": "example",
        "building": "example",
        "block": "example",
        "km": 0,
        "additional": "example"
      },
      "workingSchedule": {
        "schedule": [
          {}
        ],
        "holidays": [
          "2025-01-01"
        ]
      },
      "deliveryRestrictions": {
        "dimensionsRestrictions": {
          "weight": 1,
          "height": 1,
          "width": 1,
          "length": 1,
          "dimensionsSum": 1
        }
      },
      "features": [
        "RETURN_ALLOWED"
      ],
      "paymentTypes": [
        "PREPAID"
      ],
      "storagePeriod": 0
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "logisticPoints": [
      {
        "logisticPointId": 1,
        "brand": "MARKET",
        "address": {
          "fullAddress": "example",
          "gps": {},
          "regionId": 0,
          "city": "example",
          "street": "example",
          "house": "example",
          "building": "example",
          "block": "example",
          "km": 0,
          "additional": "example"
        },
        "workingSchedule": {
          "schedule": [
            null
          ],
          "holidays": [
            null
          ]
        },
        "deliveryRestrictions": {
          "dimensionsRestrictions": {}
        },
        "features": [
          "RETURN_ALLOWED"
        ],
        "paymentTypes": [
          "PREPAID"
        ],
        "storagePeriod": 0
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

LogisticPointId

Идентификатор пункта выдачи.

Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points.

Type: integer

Min value: 1

LogisticPointBrandType

Тип пункта выдачи:

  • MARKET — пункт выдачи Маркета.

Type: string

Const: MARKET

Example: example

GpsDTO

GPS-координаты широты и долготы.

Name

Description

latitude

Type: number

Широта.

longitude

Type: number

Долгота.
Example
{
  "latitude": 0.5,
  "longitude": 0.5
}

LogisticPointAddressDTO

Адрес пункта выдачи.

Name

Description

fullAddress

Type: string

Полный адрес.

Min length: 1

Max length: 512

Example: example

gps

Type: GpsDTO

GPS-координаты широты и долготы.

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

regionId

Type: integer

Идентификатор региона.

Информацию о регионе можно получить c помощью метода GET v2/regions.

additional

Type: string

Дополнительная информация.

Min length: 1

Max length: 1024

Example: example

block

Type: string

Номер корпуса.

Min length: 1

Max length: 16

Example: example

building

Type: string

Номер строения.

Min length: 1

Max length: 16

Example: example

city

Type: string

Город.

Min length: 1

Max length: 128

Example: example

house

Type: string

Номер дома.

Min length: 1

Max length: 16

Example: example

km

Type: integer

Порядковый номер километра, на котором располагается пункт выдачи.

Указывается, если в адресе нет улицы.

Min value: 0

street

Type: string

Улица.

Min length: 1

Max length: 128

Example: example
Example
{
  "fullAddress": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "regionId": 0,
  "city": "example",
  "street": "example",
  "house": "example",
  "building": "example",
  "block": "example",
  "km": 0,
  "additional": "example"
}

DayOfWeekType

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Type: string

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

ScheduleDayDTO

День и время работы.

Name

Description

day

Type: DayOfWeekType

День недели.

День недели:

  • MONDAY — понедельник.
  • TUESDAY — вторник.
  • WEDNESDAY — среда.
  • THURSDAY — четверг.
  • FRIDAY — пятница.
  • SATURDAY — суббота.
  • SUNDAY — воскресенье.

Enum: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

endTime

Type: string

Время конца рабочего дня.

Формат: ЧЧ:ММ.

Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

Example: example

startTime

Type: string

Время начала рабочего дня.

Формат: ЧЧ:ММ.

Pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$

Example: example
Example
{
  "day": "MONDAY",
  "startTime": "example",
  "endTime": "example"
}

LogisticPointScheduleDTO

Расписание работы пункта выдачи.

Name

Description

schedule

Type: ScheduleDayDTO[]

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

Min items: 1

Example
[
  {
    "day": "MONDAY",
    "startTime": "example",
    "endTime": "example"
  }
]

holidays

Type: string<date>[] | null

Расписание праздничных дней.

Min items: 1

Unique items: true

Example
[
  "2025-01-01"
]
Example
{
  "schedule": [
    {
      "day": "MONDAY",
      "startTime": "example",
      "endTime": "example"
    }
  ],
  "holidays": [
    "2025-01-01"
  ]
}

LogisticPointDimensionRestrictionsDTO

Ограничения по размеру одного товара.

Name

Description

dimensionsSum

Type: integer

Максимальная сумма измерений в сантиметрах.

Min value: 1

height

Type: integer

Максимальная высота в сантиметрах.

Min value: 1

length

Type: integer

Максимальная длина в сантиметрах.

Min value: 1

weight

Type: integer

Максимальный вес в граммах.

Min value: 1

width

Type: integer

Максимальная ширина в сантиметрах.

Min value: 1
Example
{
  "weight": 1,
  "height": 1,
  "width": 1,
  "length": 1,
  "dimensionsSum": 1
}

LogisticPointDeliveryRestrictionDTO

Ограничения на доставку в пункт выдачи.

Name

Description

dimensionsRestrictions

Type: LogisticPointDimensionRestrictionsDTO

Ограничения по размеру одного товара.

Example
{
  "weight": 1,
  "height": 1,
  "width": 1,
  "length": 1,
  "dimensionsSum": 1
}
Example
{
  "dimensionsRestrictions": {
    "weight": 1,
    "height": 1,
    "width": 1,
    "length": 1,
    "dimensionsSum": 1
  }
}

LogisticPointFeatureType

Свойство пункта выдачи:

  • RETURN_ALLOWED — доступен для возврата товаров.

Type: string

Const: RETURN_ALLOWED

Example: example

DeliveryPaymentType

Тип оплаты заказа:

  • PREPAID — оплата при оформлении заказа.

Type: string

Const: PREPAID

Example: example

LogisticPointDTO

Информация о пункте выдачи.

Name

Description

address

Type: LogisticPointAddressDTO

Адрес пункта выдачи.

Example
{
  "fullAddress": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  },
  "regionId": 0,
  "city": "example",
  "street": "example",
  "house": "example",
  "building": "example",
  "block": "example",
  "km": 0,
  "additional": "example"
}

brand

Type: LogisticPointBrandType

Тип пункта выдачи:

  • MARKET — пункт выдачи Маркета.

Enum: MARKET

deliveryRestrictions

Type: LogisticPointDeliveryRestrictionDTO

Ограничения на доставку в пункт выдачи.

Example
{
  "dimensionsRestrictions": {
    "weight": 1,
    "height": 1,
    "width": 1,
    "length": 1,
    "dimensionsSum": 1
  }
}

logisticPointId

Type: LogisticPointId

Идентификатор пункта выдачи.

Его можно узнать с помощью метода POST v1/businesses/{businessId}/logistics-points.

Min value: 1

Example: 1

paymentTypes

Type: DeliveryPaymentType[]

Способы оплаты, которые доступны в этом пункте выдачи.

Min items: 1

Unique items: true

Example
[
  "PREPAID"
]

storagePeriod

Type: integer

Срок хранения заказа в пункте выдачи.

Указывается в днях.

workingSchedule

Type: LogisticPointScheduleDTO

Расписание работы пункта выдачи.

Example
{
  "schedule": [
    {
      "day": "MONDAY",
      "startTime": "example",
      "endTime": "example"
    }
  ],
  "holidays": [
    "2025-01-01"
  ]
}

features

Type: LogisticPointFeatureType[] | null

Свойства пункта выдачи.

Min items: 1

Unique items: true

Example
[
  "RETURN_ALLOWED"
]
Example
{
  "logisticPointId": 1,
  "brand": "MARKET",
  "address": {
    "fullAddress": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    },
    "regionId": 0,
    "city": "example",
    "street": "example",
    "house": "example",
    "building": "example",
    "block": "example",
    "km": 0,
    "additional": "example"
  },
  "workingSchedule": {
    "schedule": [
      {
        "day": "MONDAY",
        "startTime": "example",
        "endTime": "example"
      }
    ],
    "holidays": [
      "2025-01-01"
    ]
  },
  "deliveryRestrictions": {
    "dimensionsRestrictions": {
      "weight": 1,
      "height": 1,
      "width": 1,
      "length": 1,
      "dimensionsSum": 1
    }
  },
  "features": [
    "RETURN_ALLOWED"
  ],
  "paymentTypes": [
    "PREPAID"
  ],
  "storagePeriod": 0
}

ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

Example: example
Example
{
  "nextPageToken": "example"
}

GetLogisticsPointsDTO

Информация о пунктах выдачи заказов.

Name

Description

logisticPoints

Type: LogisticPointDTO[]

Пункты выдачи заказов.

Example
[
  {
    "logisticPointId": 1,
    "brand": "MARKET",
    "address": {
      "fullAddress": "example",
      "gps": {
        "latitude": 0.5,
        "longitude": 0.5
      },
      "regionId": 0,
      "city": "example",
      "street": "example",
      "house": "example",
      "building": "example",
      "block": "example",
      "km": 0,
      "additional": "example"
    },
    "workingSchedule": {
      "schedule": [
        {
          "day": "MONDAY",
          "startTime": "example",
          "endTime": "example"
        }
      ],
      "holidays": [
        "2025-01-01"
      ]
    },
    "deliveryRestrictions": {
      "dimensionsRestrictions": {
        "weight": 1,
        "height": 1,
        "width": 1,
        "length": 1,
        "dimensionsSum": 1
      }
    },
    "features": [
      "RETURN_ALLOWED"
    ],
    "paymentTypes": [
      "PREPAID"
    ],
    "storagePeriod": 0
  }
]

paging

Type: ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Идентификатор следующей страницы.

Example
{
  "nextPageToken": "example"
}
Example
{
  "logisticPoints": [
    {
      "logisticPointId": 1,
      "brand": "MARKET",
      "address": {
        "fullAddress": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        },
        "regionId": 0,
        "city": "example",
        "street": "example",
        "house": "example",
        "building": "example",
        "block": "example",
        "km": 0,
        "additional": "example"
      },
      "workingSchedule": {
        "schedule": [
          {}
        ],
        "holidays": [
          "2025-01-01"
        ]
      },
      "deliveryRestrictions": {
        "dimensionsRestrictions": {
          "weight": 1,
          "height": 1,
          "width": 1,
          "length": 1,
          "dimensionsSum": 1
        }
      },
      "features": [
        "RETURN_ALLOWED"
      ],
      "paymentTypes": [
        "PREPAID"
      ],
      "storagePeriod": 0
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
  {
    "code": "example",
    "message": "example"
  }
]
    Example
    {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}
Example
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

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