Getting PVZ points

.

Not yet available for Market Yandex Go sellers.

If you are using an API Key token, one of the accesses in the list is required to call the method

Returns a list of order pick-up points.

Request this information regularly to keep up-to-date information in the store's system. For example, once a day.

⚙️ Limit: 10,000 requests per hour

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Responses

200 OK

Information about order pick-up points.

Body

application/json
{
    "status": "OK",
    "result": {
        "logisticPoints": [
            {
                "logisticPointId": 0,
                "brand": "MARKET",
                "address": {
                    "fullAddress": "string",
                    "gps": {
                        "latitude": 0,
                        "longitude": 0
                    },
                    "regionId": 0,
                    "city": "string",
                    "street": "string",
                    "house": "string",
                    "building": "string",
                    "block": "string",
                    "km": 0,
                    "additional": "string"
                },
                "workingSchedule": {
                    "schedule": [
                        {
                            "day": "MONDAY",
                            "startTime": "string",
                            "endTime": "string"
                        }
                    ],
                    "holidays": [
                        "string"
                    ]
                },
                "deliveryRestrictions": {
                    "dimensionsRestrictions": {
                        "weight": 0,
                        "height": 0,
                        "width": 0,
                        "length": 0,
                        "dimensionsSum": 0
                    }
                },
                "features": [
                    "RETURN_ALLOWED"
                ],
                "paymentTypes": [
                    "PREPAID"
                ],
                "storagePeriod": 0
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result

Type: GetLogisticsPointsDTO

Information about order pick-up points.

ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetLogisticsPointsDTO

Information about order pick-up points.

Name

Description

logisticPoints*

Type: LogisticPointDTO[]

Order pick-up points.
Information about the pick-up point.

paging

Type: ForwardScrollingPagerDTO

The ID of the next page.

LogisticPointDTO

Information about the pick-up point.

Name

Description

address*

Type: LogisticPointAddressDTO

The address of the pick-up point.

brand*

Type: LogisticPointBrandType

Type of pick-up point:

  • MARKET — the Market pick-up point.

Enum: MARKET

deliveryRestrictions*

Type: LogisticPointDeliveryRestrictionDTO

Restrictions on delivery to the pick-up point.

logisticPointId*

Type: integer<int64>

ID of the pick-up point.

It can be found using the method POST v1/businesses/{businessId}/logistics-points.

Min value: 1

paymentTypes*

Type: DeliveryPaymentType[]

Payment methods that are available at this pick-up point.
Order payment type:

  • PREPAID — payment at checkout.

Enum: PREPAID

Min items: 1

Unique items  

storagePeriod*

Type: integer<int64>

The shelf life of the order at the pick-up point.

Specified in days.

workingSchedule*

Type: LogisticPointScheduleDTO

The opening hours of the pick-up point.

features

Type: LogisticPointFeatureType[]

Properties of the pick-up point.
Property of the pick-up point:

  • RETURN_ALLOWED — available for the return of goods.

Enum: RETURN_ALLOWED

Min items: 1

Unique items  

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

LogisticPointAddressDTO

The address of the pick-up point.

Name

Description

fullAddress*

Type: string

Full address.

Min length: 1

Max length: 512

gps*

Type: GpsDTO

GPS coordinates of latitude and longitude.

regionId*

Type: integer<int64>

ID of the region.

Information about the region can be obtained using the method GET v2/regions.

additional

Type: string

Additional information.

Min length: 1

Max length: 1024

block

Type: string

Building number.

Min length: 1

Max length: 16

building

Type: string

Building number.

Min length: 1

Max length: 16

city

Type: string

City.

Min length: 1

Max length: 128

house

Type: string

The house number.

Min length: 1

Max length: 16

km

Type: integer<int32>

The ordinal number of the kilometer where the pick-up point is located.

Indicated if there is no street in the address.

Min value: 0

street

Type: string

Street.

Min length: 1

Max length: 128

LogisticPointBrandType

Type of pick-up point:

  • MARKET — the Market pick-up point.

Type

Description

LogisticPointBrandType

Enum: MARKET

LogisticPointDeliveryRestrictionDTO

Restrictions on delivery to the pick-up point.

Name

Description

dimensionsRestrictions*

Type: LogisticPointDimensionRestrictionsDTO

Restrictions on the size of a single product.

DeliveryPaymentType

Order payment type:

  • PREPAID — payment at checkout.

Type

Description

DeliveryPaymentType

Enum: PREPAID

LogisticPointScheduleDTO

The opening hours of the pick-up point.

Name

Description

schedule*

Type: ScheduleDayDTO[]

Work schedule.
The day and time of work.

Min items: 1

holidays

Type: string[]

The schedule of public holidays.
A public holiday.

Date format: YYYY-MM-DD.

Min items: 1

Unique items  

LogisticPointFeatureType

Property of the pick-up point:

  • RETURN_ALLOWED — available for the return of goods.

Type

Description

LogisticPointFeatureType

Enum: RETURN_ALLOWED

GpsDTO

GPS coordinates of latitude and longitude.

Name

Description

latitude*

Type: number

Width.

longitude*

Type: number

Longitude.

LogisticPointDimensionRestrictionsDTO

Restrictions on the size of a single product.

Name

Description

dimensionsSum*

Type: integer<int32>

The maximum amount of measurements in centimeters.

Min value: 1

height*

Type: integer<int32>

The maximum height in centimeters.

Min value: 1

length*

Type: integer<int32>

The maximum length in centimeters.

Min value: 1

weight*

Type: integer<int32>

Maximum weight in grams.

Min value: 1

width*

Type: integer<int32>

Maximum width in centimeters.

Min value: 1

ScheduleDayDTO

The day and time of work.

Name

Description

day*

Type: DayOfWeekType

Day of the week:

  • MONDAY — Monday.
  • TUESDAY — Tuesday.
  • WEDNESDAY — wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY — Saturday.
  • SUNDAY — Sunday.

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

endTime*

Type: string

The time of the end of the working day.

Format: HH:MM.

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

startTime*

Type: string

The start time of the working day.

Format: HH:MM.

Pattern: ^([0-1][0-9]<code>&#124;</code>2[0-3]):[0-5][0-9]$

DayOfWeekType

Day of the week:

  • MONDAY — Monday.
  • TUESDAY — Tuesday.
  • WEDNESDAY — wednesday.
  • THURSDAY — Thursday.
  • FRIDAY — Friday.
  • SATURDAY — Saturday.
  • SUNDAY — Sunday.

Type

Description

DayOfWeekType

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

400 Bad Request

The request contains incorrect data. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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