Retrieve list of pickup points

Method to retrieve order pickup points. Relevant for pharmaceutical distributors.

Request

GET

/places/pickup-points

Query parameters

Name	Description
origin_id*	Type: string Unique region identifier in the partner’s system.
cursor	Type: string Cursor for fetching the next page.
limit	Type: integer Limit. Restricts the number of items per response. Example: `100`

Headers

Name

Description

Authorization*

Type: string

Token received in response to the /security/oauth/token request

Responses

200 OK

Successful response.

Body

application/json

{
    "items": [
        {
            "id": "123",
            "name": "Best Pharmacy",
            "address": {
                "short": "Lenin St., 15",
                "city": "Moscow",
                "street": "Lenin",
                "house": "15",
                "entrance": "3",
                "floor": "5",
                "apartment": "42",
                "doorcode": "1234#",
                "comment": "Entrance from the courtyard"
            },
            "location": {
                "latitude": "55.755814",
                "longitude": "37.617634"
            },
            "availability": false,
            "schedule": {
                "base": [
                    [
                        {
                            "weekday": "tuesday",
                            "from": "08:00",
                            "to": "20:00"
                        }
                    ]
                ],
                "override": [
                    {
                        "started_at": "2025-02-22",
                        "finished_at": "2025-02-23",
                        "from": "08:00",
                        "to": "20:00"
                    }
                ]
            }
        }
    ],
    "cursor": "string"
}

Name

Description

cursor

Type: string

Cursor for fetching the next page. Do not send if no more data.

items

Type: PickupPoint[]

PickupPoint

Name	Description
address*	Type: Address
availability*	Type: boolean Pickup point availability
id*	Type: string Pickup point ID Example: `123`
location*	Type: Location
name*	Type: string Pickup point name Example: `Best Pharmacy`
schedule*	Type: Schedule Time is specified in 24-hour format in the pickup point’s locale. For 24/7 availability, use 00:00-24:00.

Address

Name	Description
short*	Type: string Short address description. Example: `Lenin St., 15`
apartment	Type: string Apartment number Example: `42` Max length: `60`
city	Type: string City Example: `Moscow`
comment	Type: string Additional address comment. Example: `Entrance from the courtyard` Max length: `1000`
doorcode	Type: string Intercom code Example: `1234#` Max length: `60`
entrance	Type: string Entrance number Example: `3` Max length: `60`
floor	Type: string Floor number Example: `5` Max length: `60`
house	Type: string Building number Example: `15` Max length: `60`
street	Type: string Street Example: `Lenin` Max length: `255`

Location

Name

Description

latitude*

Type: number

Latitude

Example: 55.755814

longitude*

Type: number

Longitude

Example: 37.617634

Schedule

Time is specified in 24-hour format in the pickup point’s locale. For 24/7 availability, use 00:00-24:00.

Name

Description

base*

Type: IntervalV1[][]

Regular working hours.

override

Type: OverrideIntervalV1[]

Temporary change in working hours.

IntervalV1

Name	Description
from*	Type: string Beginning of interval (H:i format) Example: `08:00`
to*	Type: string End of interval (H:i format) Example: `20:00`
weekday*	Type: string Day of week Example: `tuesday` Enum: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`

OverrideIntervalV1

Name	Description
finished_at*	Type: string<date> End date (inclusive) of overridden schedule. Example: `2025-02-23`
from*	Type: string Beginning of interval (H:i format) Example: `08:00`
started_at*	Type: string<date> Start date (inclusive) of overridden schedule. Example: `2025-02-22`
to*	Type: string End of interval (H:i format) Example: `20:00`

400 Bad Request

Bad request. Invalid parameters.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

401 Unauthorized

Authorisation failed – token expired or not provided.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

404 Not Found

Resource not found.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

500 Internal Server Error

Internal server error.

Body

application/json

{
    "message": "string",
    "code": 0,
    "details": {}
}

Name	Description
code*	Type: integer Error code.
message*	Type: string Error message.
details	Type: object

Was the article helpful?

Information about the store

Blocking stores