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 data 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: string

The type of response. Possible values:

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

Enum: OK, ERROR

result
Type: object

logisticPoints*

Type: object[]

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

paging
Type: object

nextPageToken

Type: string

ID of the next results page.

The ID of the next page.

Information about order pick-up points.

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

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

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

Enum: OK, 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

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

A list of errors.
The general error format.

Min items: 1

status

Type: string

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

A list of errors.
The general error format.

Min items: 1

status

Type: string

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

A list of errors.
The general error format.

Min items: 1

status

Type: string

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.