Information about a single point of sale

Info

Console

The method is available for the DBS model.

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

settings-management — Store settings
all-methods — Full account management
all-methods:read-only — View all data

Returns information about the store's points of sale.

⚙️ Limit: 100,000 requests per hour

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/outlets/{outletId}

Path parameters

Name

Description

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

outletId

Type: integer

The ID of the point of sale.

Min value: 1

Responses

200 OK

Information about the point of sale.

Body

application/json

{
  "outlet": {
    "name": "example",
    "type": "DEPOT",
    "coords": "example",
    "isMain": true,
    "shopOutletCode": "example",
    "visibility": "HIDDEN",
    "address": {
      "regionId": 0,
      "street": "example",
      "number": "example",
      "building": "example",
      "estate": "example",
      "block": "example",
      "additional": "example",
      "km": 0,
      "city": "example"
    },
    "phones": [
      "example"
    ],
    "workingSchedule": {
      "workInHoliday": true,
      "scheduleItems": [
        {}
      ]
    },
    "deliveryRules": [
      {
        "minDeliveryDays": 0,
        "maxDeliveryDays": 0,
        "deliveryServiceId": 0,
        "orderBefore": 0,
        "priceFreePickup": 0.5,
        "unspecifiedDeliveryInterval": true
      }
    ],
    "storagePeriod": 0
  }
}

Name

Description

outlet

Type: object

All of 2 types

Type: object

address

Type: object

regionId	Type: integer ID of the region. You can get the ID using a request GET v2/regions. Types of regions when creating and editing points of sale Specify only the following types of regions `TOWN` (city), `CITY` (large city) and `REPUBLIC_AREA` (district of the subject of the federation). The type of the region is specified in the output parameters `type` requests GET v2/regions and GET v2/regions/{regionId}.
additional	Type: string Additional information. Example: `example`
block	Type: string Building number. Max length: `16` Example: `example`
building	Type: string Building number. Max length: `16` Example: `example`
city	Type: string In the responses, cities and towns are returned in the parameter `regionId`. Max length: `200` Example: `example`
estate	Type: string Ownership number. Max length: `16` Example: `example`
km	Type: integer The ordinal number of the kilometer of the road where the point of sale is located, if there is no street.
number	Type: string The house number. Max length: `256` Example: `example`
street	Type: string Street. Max length: `512` Example: `example`

The address of the point of sale.

Example

{
  "regionId": 0,
  "street": "example",
  "number": "example",
  "building": "example",
  "estate": "example",
  "block": "example",
  "additional": "example",
  "km": 0,
  "city": "example"
}

name

Type: string

The name of the point of sale.

Example: example

phones

Type: string[]

The phone numbers of the point of sale. Send the number in the format: +<country code>(<city code>)<number>[#<extension>].

Examples:

+7 (999) 999-99-99
+7 (999) 999-99-99#1234

Min items: 1

Unique items: true

Example

[
  "example"
]

type

Type: string

The type of point of sale.

Possible values:

DEPOT — the order pick-up point.
MIXED — a mixed type of point of sale (sales floor and order pick-up point).
RETAIL — retail point of sale (sales floor).
NOT_DEFINED — unknown type of point of sale. An error occurred when determining the type.

Enum: DEPOT, MIXED, RETAIL, NOT_DEFINED

workingSchedule

Type: object

scheduleItems

Type: object[]

endDay	Type: string 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 point of sale is open until the specified hour. Format: `HH:MM`. Pattern: `^([0-1][0-9]\|2[0-3]):[0-5][0-9]$` Example: `23:59`
startDay	Type: string 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`
startTime	Type: string The point of sale is open starting from the specified hour. Format: `HH:MM`. Pattern: `^([0-1][0-9]\|2[0-3]):[0-5][0-9]$` Example: `09:59`

A list of the point of sale's opening hours.

Min items: 1

Example

[
  {
    "startDay": "MONDAY",
    "endDay": "MONDAY",
    "startTime": "09:59",
    "endTime": "23:59"
  }
]

workInHoliday

Type: boolean

Indicates whether the point of sale is open on public holidays.

Possible values:

false — The point of sale is closed on public holidays.
true — The point of sale is open on public holidays.

The list of operating modes of the point of sale.

Example

{
  "workInHoliday": true,
  "scheduleItems": [
    {
      "startDay": "MONDAY",
      "endDay": "MONDAY",
      "startTime": "09:59",
      "endTime": "23:59"
    }
  ]
}

coords

Type: string

Coordinates of the point of sale.

Format: longitude, latitude. Delimiters: comma and/or space. For example, 20.4522144, 54.7104264.

If no parameter is passed, the coordinates will be determined by the values of the parameters nested in address.

Example: example

deliveryRules

Type: object[]

deliveryServiceId	Type: integer ID of the product delivery service to the point of sale. Information about the delivery service can be obtained by requesting GET delivery/services.
maxDeliveryDays	Type: integer The maximum delivery time for goods to the point of sale. It is specified in business days. Minimum value: `0` — delivery on the day of the order. Maximum value: `60`. Acceptable delivery time (the difference between `minDeliveryDays` and `maxDeliveryDays`) depend on the region. For delivery in your region, the difference should not exceed two days. For example, if `minDeliveryDays` is equal to 1, then for `maxDeliveryDays` values from 1 to 3 are allowed. For delivery to other regions: If `minDeliveryDays` up to 18 days, the difference should not exceed four days. For example, if `minDeliveryDays` is equal to 10, then for `maxDeliveryDays` values from 10 to 14 are allowed. If `minDeliveryDays` more than 18 days, the difference should not be more than twice. For example, if `minDeliveryDays` is equal to 21, then for `maxDeliveryDays` values from 21 to 42 are allowed. Required parameter if `type="DEPOT"` or `type="MIXED"`. Mutually exclusive with the parameter `unspecifiedDeliveryInterval`. Min value: `0` Max value: `60`
minDeliveryDays	Type: integer The minimum delivery time for goods to the point of sale. It is specified in business days. Minimum value: `0` — delivery on the day of the order. Maximum value: `60`. Acceptable delivery time (the difference between `minDeliveryDays` and `maxDeliveryDays`) depend on the region. For delivery in your region, the difference should not exceed two days. For example, if `minDeliveryDays` is equal to 1, then for `maxDeliveryDays` values from 1 to 3 are allowed. For delivery to other regions: If `minDeliveryDays` up to 18 days, the difference should not exceed four days. For example, if `minDeliveryDays` is equal to 10, then for `maxDeliveryDays` values from 10 to 14 are allowed. If `minDeliveryDays` more than 18 days, the difference should not be more than twice. For example, if `minDeliveryDays` is equal to 21, then for `maxDeliveryDays` values from 21 to 42 are allowed. Required parameter if `type="DEPOT"` or `type="MIXED"`. Mutually exclusive with the parameter `unspecifiedDeliveryInterval`. Min value: `0` Max value: `60`
orderBefore	Type: integer The hour before which the customer needs to place the order so that it can be delivered to the point of sale on time from `minDeliveryDays` before `maxDeliveryDays`. If the customer places the order after the specified hour, it will be delivered on time from `minDeliveryDays` + 1 business day before `maxDeliveryDays` + 1 working day. Default value: `24`. Min value: `0` Max value: `24`
priceFreePickup	Type: number The price of the product, starting from which the free pickup of the product from the point of sale is valid.
unspecifiedDeliveryInterval	Type: boolean Indicates the delivery of goods to the point of sale on order. This flag is set if: the exact delivery time to the point of sale is unknown in advance (for example, if the store collects several orders for shipment to the point or locality). all products are made or delivered to order. Possible values: `true` — The goods are delivered to the point of sale on order. The parameter is specified only with the value `true`. Mutually exclusive with parameters `minDeliveryDays` and `maxDeliveryDays`.

Information about the terms of delivery for this point of sale.

Required parameter if the parameter type=DEPOT or type=MIXED.

Min items: 1

Example

[
  {
    "minDeliveryDays": 0,
    "maxDeliveryDays": 0,
    "deliveryServiceId": 0,
    "orderBefore": 0,
    "priceFreePickup": 0.5,
    "unspecifiedDeliveryInterval": true
  }
]

isMain

Type: boolean

Indicates the main point of sale.

Possible values:

false — a non-primary point of sale.
true — the main point of sale.

shopOutletCode

Type: string

The ID of the point of sale assigned by the store.

Example: example

storagePeriod

Type: integer

The storage period of the order at its own order pick-up point. It is calculated in days.

visibility

Type: string

The status of the point of sale.

Possible values:

HIDDEN — the point of sale is disabled.
VISIBLE — The point of sale is enabled.
UNKNOWN — unknown condition of the point of sale. An error occurred when determining the status.

Enum: HIDDEN, VISIBLE, UNKNOWN

Information about the point of sale.

Example

{
  "name": "example",
  "type": "DEPOT",
  "coords": "example",
  "isMain": true,
  "shopOutletCode": "example",
  "visibility": "HIDDEN",
  "address": {
    "regionId": 0,
    "street": "example",
    "number": "example",
    "building": "example",
    "estate": "example",
    "block": "example",
    "additional": "example",
    "km": 0,
    "city": "example"
  },
  "phones": [
    "example"
  ],
  "workingSchedule": {
    "workInHoliday": true,
    "scheduleItems": [
      {
        "startDay": "MONDAY",
        "endDay": "MONDAY",
        "startTime": "09:59",
        "endTime": "23:59"
      }
    ]
  },
  "deliveryRules": [
    {
      "minDeliveryDays": 0,
      "maxDeliveryDays": 0,
      "deliveryServiceId": 0,
      "orderBefore": 0,
      "priceFreePickup": 0.5,
      "unspecifiedDeliveryInterval": true
    }
  ],
  "storagePeriod": 0
}

Type: object

Type: integer

The ID of the point of sale assigned by Yandex.Market.

moderationReason

Type: string

The moderation status.

Example: example

region

Type: object

id	Type: integer ID of the region.
name	Type: string The name of the region. Example: `example`
type	Type: string The type of region. Possible values: `CITY_DISTRICT` — the area of the city. `CITY` — a large city. `CONTINENT` — the continent. `COUNTRY_DISTRICT` — area. `COUNTRY` — country. `REGION` — region. `REPUBLIC_AREA` — the district of the subject of the federation. `REPUBLIC` — the subject of the Federation. `SUBWAY_STATION` — the metro station. `VILLAGE` — city. `OTHER` — unknown region. Enum: `OTHER`, `CONTINENT`, `REGION`, `COUNTRY`, `COUNTRY_DISTRICT`, `REPUBLIC`, `CITY`, `VILLAGE`, `CITY_DISTRICT`, `SUBWAY_STATION`, `REPUBLIC_AREA`
parent	Type: unknown Information about the parent region. Parent regions are specified up to the country level. Example: `null`

The delivery region.

Example

{
  "id": 0,
  "name": "example",
  "type": "OTHER",
  "parent": null
}

shopOutletId

Type: string

Instead, use shopOutletCode.

The ID of the point of sale set by the store.

Example: example

status

Type: string

The status of the point of sale.

Possible values:

AT_MODERATION — it is being checked.
FAILED — failed verification and was rejected by the moderator.
MODERATED — tested and approved.
NONMODERATED — a new point needs to be checked.
UNKNOWN — the status is not specified. An error occurred when determining the status.

Enum: AT_MODERATION, FAILED, MODERATED, NONMODERATED, UNKNOWN

workingTime

Type: string

Instead, use workingSchedule.

Working hours.

Example: example

Example

{
  "id": 0,
  "status": "AT_MODERATION",
  "region": {
    "id": 0,
    "name": "example",
    "type": "OTHER",
    "parent": null
  },
  "shopOutletId": "example",
  "workingTime": "example",
  "moderationReason": "example"
}

Information about the point of sale.

Example

{
  "name": "example",
  "type": "DEPOT",
  "coords": "example",
  "isMain": true,
  "shopOutletCode": "example",
  "visibility": "HIDDEN",
  "address": {
    "regionId": 0,
    "street": "example",
    "number": "example",
    "building": "example",
    "estate": "example",
    "block": "example",
    "additional": "example",
    "km": 0,
    "city": "example"
  },
  "phones": [
    "example"
  ],
  "workingSchedule": {
    "workInHoliday": true,
    "scheduleItems": [
      {
        "startDay": "MONDAY",
        "endDay": "MONDAY",
        "startTime": "09:59",
        "endTime": "23:59"
      }
    ]
  },
  "deliveryRules": [
    {
      "minDeliveryDays": 0,
      "maxDeliveryDays": 0,
      "deliveryServiceId": 0,
      "orderBefore": 0,
      "priceFreePickup": 0.5,
      "unspecifiedDeliveryInterval": true
    }
  ],
  "storagePeriod": 0
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

401 Unauthorized

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

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json

{
  "status": "OK"
}

Type: object

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

Was the article helpful?

Application documents

Multiple points of sale