Information about the products that are placed in the specified store

The method is available for all models.

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 products that are placed in the specified store. The placement parameters are specified for each product.

, Limit: 10,000 items per minute

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The store's ID in the merchant profile.

To find out the IDs of your stores, use the request GET 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.
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_number and page_size they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
    "offerIds": [
        "string"
    ],
    "statuses": [
        "PUBLISHED"
    ],
    "categoryIds": [
        0
    ],
    "vendorNames": [
        "string"
    ],
    "tags": [
        "string"
    ]
}

Name

Description

categoryIds

Type: integer[]

Filter by category on the Market.

Min items: 1

Unique items  

offerIds

Type: string[]

The IDs of the products that information is needed about.

This list is returned only in its entirety.

Do not use this field at the same time as filters based on card statuses, categories, brands, or tags. If you want to use filters, leave the field empty.

If you are requesting information on specific SKUs, do not fill in:

  • page_token
  • limit


Your SKU is the product identifier in your system.

SKU Usage Rules:

  • Each product must have its own SKU.

  • An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Min items: 1

Max items: 200

Unique items  

statuses

Type: OfferCampaignStatusType[]

Filter by product status.
Product status:

  • PUBLISHED — Ready for sale.
  • CHECKING — On inspection.
  • DISABLED_BY_PARTNER — Hidden by you.
  • REJECTED_BY_MARKET — Rejected.
  • DISABLED_AUTOMATICALLY — Fix the errors.
  • CREATING_CARD — A card is being created.
  • NO_CARD — I need a card.
  • NO_STOCKS — Not in stock.
  • ARCHIVED — In the archive.

What does each of the statuses mean?

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

Min items: 1

Unique items  

tags

Type: string[]

Filter by tags.

Min items: 1

Unique items  

vendorNames

Type: string[]

Filter by brand.

Min items: 1

Unique items  

OfferCampaignStatusType

Product status:

  • PUBLISHED — Ready for sale.
  • CHECKING — On inspection.
  • DISABLED_BY_PARTNER — Hidden by you.
  • REJECTED_BY_MARKET — Rejected.
  • DISABLED_AUTOMATICALLY — Fix the errors.
  • CREATING_CARD — A card is being created.
  • NO_CARD — I need a card.
  • NO_STOCKS — Not in stock.
  • ARCHIVED — In the archive.

What does each of the statuses mean?

Type

Description

OfferCampaignStatusType

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

Responses

200 OK

A list of products placed in the specified store.

Body

application/json
{
    "status": "OK",
    "result": {
        "paging": {
            "nextPageToken": "string",
            "prevPageToken": "string"
        },
        "offers": [
            {
                "offerId": "string",
                "quantum": {
                    "minQuantity": 0,
                    "stepQuantity": 0
                },
                "available": false,
                "basicPrice": {
                    "value": 0,
                    "currencyId": "RUR",
                    "discountBase": 0,
                    "updatedAt": "2022-12-29T18:02:01Z"
                },
                "campaignPrice": {
                    "value": 0,
                    "discountBase": 0,
                    "currencyId": "RUR",
                    "vat": 0,
                    "updatedAt": "2022-12-29T18:02:01Z"
                },
                "status": "PUBLISHED",
                "errors": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ],
                "warnings": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: GetCampaignOffersResultDTO

The list of products in the specified store.

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GetCampaignOffersResultDTO

The list of products in the specified store.

Name

Description

offers*

Type: GetCampaignOfferDTO[]

The product list page.
Product placement parameters in the store.
Information about the new product price.

paging

Type: ScrollingPagerDTO

Information about the result pages.
The ID of the next page.

ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetCampaignOfferDTO

Product placement parameters in the store.

Name

Description

offerId*

Type: string

Your SKU is the product identifier in your system.

SKU Usage Rules:

  • Each product must have its own SKU.

  • An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

available

⦸

Type: boolean

This parameter is deprecated.

Instead, use methods to hide goods from the showcase:

Whether the product is on sale.

basicPrice

Type: GetPriceWithDiscountDTO

The price of the product for all stores.
Price with discount indication.
The time of the last update.

campaignPrice

Type: GetPriceWithVatDTO

The price set in a separate store.
The price includes the discount, currency, and the time of the last update.
The time of the last update.

errors

Type: OfferErrorDTO[]

Errors that prevent the product from being placed in the showcase.
An error message related to the product placement.

Min items: 1

quantum

Type: QuantumDTO

Setting up a quantum sale. What does it mean?

status

Type: OfferCampaignStatusType

Product status:

  • PUBLISHED — Ready for sale.
  • CHECKING — On inspection.
  • DISABLED_BY_PARTNER — Hidden by you.
  • REJECTED_BY_MARKET — Rejected.
  • DISABLED_AUTOMATICALLY — Fix the errors.
  • CREATING_CARD — A card is being created.
  • NO_CARD — I need a card.
  • NO_STOCKS — Not in stock.
  • ARCHIVED — In the archive.

What does each of the statuses mean?

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

warnings

Type: OfferErrorDTO[]

Warnings that do not prevent the product from being placed in the showcase.
An error message related to the product placement.

Min items: 1

ScrollingPagerDTO

Information about the result pages.

Name

Description

nextPageToken

Type: string

ID of the next results page.

prevPageToken

Type: string

ID of the previous results page.

GetPriceWithDiscountDTO

The price includes the discount and the time of the last update.

Name

Description

updatedAt*

Type: string<date-time>

The time of the last update.

currencyId

Type: CurrencyType

Currency.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

discountBase

Type: number

The crossed-out price.

The number must be an integer. You can specify a price with a discount from 5 to 99%.

Pass this parameter every time the price is updated if you provide a discount on the product.

Min value (exclusive): 0

value

Type: number

Meaning.

Min value (exclusive): 0

GetPriceWithVatDTO

The price includes VAT and the time of the last update.

Name

Description

updatedAt*

Type: string<date-time>

The time of the last update.

currencyId

Type: CurrencyType

The currency in which the price of the product is indicated.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

discountBase

Type: number

The price of the product is without discount.

The number must be an integer. You can specify a price with a discount from 5 to 99%.

Pass this parameter every time the price is updated if you provide a discount on the product.

value

Type: number

The price of the product.

vat

Type: integer<int32>

The VAT identifier used for the product:

  • 2 — 10% VAT. For example, it is used in the sale of certain food and medical products.
  • 5 — 0% VAT. For example, it is used when selling goods exported in the customs procedure of export, or when providing services for the international transportation of goods.
  • 6 — VAT is not charged, it is used only for certain types of services.
  • 7 — 20% VAT. Basic VAT starting in 2019.
  • 10 — 5% VAT. VAT for the simplified taxation system (USN).
  • 11 — 7% VAT. VAT for the simplified taxation system (USN).

If the parameter is omitted, the VAT set in the cabinet is used.

For sellers of the Yandex Go Market transfer and receipt of VAT is not available.

OfferErrorDTO

An error message related to the product placement.

Name

Description

comment

Type: string

Explanation.

message

Type: string

The type of error.

QuantumDTO

Setting up a quantum sale.

To reset the previously set values, pass an empty parameter quantum.

Example
{
  "offers": [
    {
      "offerId": "08e35dc1-89a2-11e3-8055-0015e9b8c48d",
      "quantum": {}
    }
  ]
}

Name

Description

minQuantity

Type: integer<int32>

The minimum number of product units in the order. For example, if you specify 10, the customer will be able to add at least 10 items to the cart.

If the quantity of goods in stock is less than the specified quantity, the restriction will not work and the buyer will be able to order it.

Min value: 1

stepQuantity

Type: integer<int32>

By how many units the buyer will be able to increase the quantity of goods in the basket.

For example, if you set 5, the buyer will be able to add only 5, 10, 15, ... items to the order.

If the quantity of goods in stock does not reach the quantum, the restriction will not work and the buyer will be able to order a quantity that is not a multiple of the quantum.

Min value: 1

Max value: 100

CurrencyType

Currency codes:

  • RUR — the Russian ruble.
  • UAH — the Ukrainian hryvnia.
  • BYR — Belarusian ruble.
  • KZT — Kazakhstani tenge.
  • UZS — Uzbek sum.

Type

Description

CurrencyType

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

400 Bad Request

The request contains incorrect data.

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 mistakes.
  • 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.

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 mistakes.
  • 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.

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 mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found.

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 mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded.

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 mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal server 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 mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR
Previous
In the office
Next
In the office