Changing information about the point of sale
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
Changes the information about the store's point of sale on the Market.
| ⚙️ Limit: 100,000 requests per hour |
|---|
Request
PUT
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:
⚠️ Do not confuse it with:
Min value: |
|
outletId |
Type: integer The ID of the point of sale. Min value: |
Body
application/json
{
"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
}
|
Name |
Description |
||||||||||||||||||
|
address |
Type: object
The address of the point of sale. Example |
||||||||||||||||||
|
name |
Type: string The name of the point of sale. Example: |
||||||||||||||||||
|
phones |
Type: string[] The phone numbers of the point of sale.
Send the number in the format: Examples:
Min items: Unique items: Example |
||||||||||||||||||
|
type |
Type: string The type of point of sale. Possible values:
Enum: |
||||||||||||||||||
|
workingSchedule |
Type: object
The list of operating modes of the point of sale. Example |
||||||||||||||||||
|
coords |
Type: string Coordinates of the point of sale. Format: longitude, latitude. Delimiters: comma and/or space. For example, If no parameter is passed, the coordinates will be determined by the values of the parameters nested in Example: |
||||||||||||||||||
|
deliveryRules |
Type: object[]
Information about the terms of delivery for this point of sale. Required parameter if the parameter Min items: Example |
||||||||||||||||||
|
isMain |
Type: boolean Indicates the main point of sale. Possible values:
|
||||||||||||||||||
|
shopOutletCode |
Type: string The ID of the point of sale assigned by the store. 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:
Enum: |
Responses
200 OK
An empty answer.
Body
application/json
{
"status": "OK"
}
Type: object
400 Bad Request
The request contains incorrect data. Learn more about errors when working with points of sale
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
pathParams:
- description: "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.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 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**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
name: campaignId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
- description: The ID of the point of sale.
name: outletId
in: path
required: true
schema:
type: integer
format: int64
minimum: 1
searchParams: []
headers: []
body: |-
{
"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
}
schema:
type: object
allOf:
- description: Information about the point of sale.
type: object
required:
- name
- type
- address
- phones
- workingSchedule
properties:
name:
description: |
The name of the point of sale.
type: string
type:
description: >
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.
type: string
enum:
- DEPOT
- MIXED
- RETAIL
- NOT_DEFINED
coords:
description: >
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`.
type: string
isMain:
description: >
Indicates the main point of sale.
Possible values:
* `false` — a non-primary point of
sale.
* `true` — the main point of sale.
type: boolean
shopOutletCode:
description: The ID of the point of sale assigned by the store.
type: string
visibility:
description: >
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.
type: string
enum:
- HIDDEN
- VISIBLE
- UNKNOWN
address:
description: |
The address of the point of sale.
type: object
required:
- regionId
properties:
regionId:
description: "ID of the region.\n\nYou can get the ID using a request [GET\_v2/regions](../../reference/regions/searchRegionsByName.md).\n\n{% note alert \"Types of regions when creating and editing points of sale\" %}\n\nSpecify 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](../../reference/regions/searchRegionsByName.md) and [GET\_v2/regions/{regionId}](../../reference/regions/searchRegionsById.md).\n\n{% endnote %}\n"
type: integer
format: int64
street:
description: Street.
type: string
maxLength: 512
number:
description: The house number.
type: string
maxLength: 256
building:
description: Building number.
type: string
maxLength: 16
estate:
description: Ownership number.
type: string
maxLength: 16
block:
description: Building number.
type: string
maxLength: 16
additional:
description: Additional information.
type: string
km:
description: >-
The ordinal number of the kilometer of the road where the point
of sale is located, if there is no street.
type: integer
format: int32
city:
description: "{% note warning \"In the responses, cities and towns are returned in the parameter `regionId`.\" %}\n\n\_\n\n{% endnote %}\n"
maxLength: 200
type: string
deprecated: true
phones:
description: >
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`
type: array
minItems: 1
uniqueItems: true
items:
type: string
minLength: 1
workingSchedule:
description: |
The list of operating modes of the point of sale.
type: object
required:
- scheduleItems
properties:
workInHoliday:
description: >
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.
type: boolean
scheduleItems:
description: |
A list of the point of sale's opening hours.
type: array
minItems: 1
items:
description: The opening hours of the point of sale.
type: object
required:
- startDay
- endDay
- startTime
- endTime
properties:
startDay:
description: |
Day of the week:
* `MONDAY` — Monday.
* `TUESDAY` — Tuesday.
* `WEDNESDAY` — wednesday.
* `THURSDAY` — Thursday.
* `FRIDAY` — Friday.
* `SATURDAY` — Saturday.
* `SUNDAY` — Sunday.
type: string
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
endDay:
description: |
Day of the week:
* `MONDAY` — Monday.
* `TUESDAY` — Tuesday.
* `WEDNESDAY` — wednesday.
* `THURSDAY` — Thursday.
* `FRIDAY` — Friday.
* `SATURDAY` — Saturday.
* `SUNDAY` — Sunday.
type: string
enum:
- MONDAY
- TUESDAY
- WEDNESDAY
- THURSDAY
- FRIDAY
- SATURDAY
- SUNDAY
startTime:
description: >
The point of sale is open starting from the specified
hour.
Format: `HH:MM`.
type: string
pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$
example: '09:59'
endTime:
description: |
The point of sale is open until the specified hour.
Format: `HH:MM`.
type: string
pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$
example: '23:59'
deliveryRules:
description: |
Information about the terms of delivery for this point of sale.
Required parameter if the parameter `type=DEPOT` or `type=MIXED`.
type: array
nullable: true
minItems: 1
items:
description: Information about the terms of delivery for this point of sale.
type: object
properties:
minDeliveryDays:
description: >
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`.
type: integer
format: int32
minimum: 0
maximum: 60
maxDeliveryDays:
description: >
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`.
type: integer
format: int32
minimum: 0
maximum: 60
deliveryServiceId:
description: "ID of the product delivery service to the point of sale.\n\nInformation about the delivery service can be obtained by requesting [GET\_delivery/services](../../reference/orders/getDeliveryServices.md).\n"
type: integer
format: int64
orderBefore:
description: >
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`.
type: integer
format: int32
minimum: 0
maximum: 24
priceFreePickup:
description: >-
The price of the product, starting from which the free pickup
of the product from the point of sale is valid.
type: number
unspecifiedDeliveryInterval:
description: >
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`.
type: boolean
storagePeriod:
description: >-
The storage period of the order at its own order pick-up point. It
is calculated in days.
type: integer
format: int64
bodyType: application/json
method: put
security:
- type: apiKey
name: 'Api-Key'
in: header
- type: oauth2
x-inline: true
flows:
implicit:
authorizationUrl: https://oauth.yandex.ru/authorize
scopes:
market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/campaigns/{campaignId}/outlets/{outletId}
host: https://api.partner.market.yandex.ru
No longer supported, please use an alternative and newer version.