Product Report

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 detailed report on the products that you have placed on the Market. You can use the report to find out, for example, about stock balances, storage conditions for your goods, and so on.

, Limit: 5,000 items per minute

Request

POST

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

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

Body

application/json
{
    "shopSkus": [
        "string"
    ]
}

Name

Description

shopSkus*

Type: string[]

A list of your SKU IDs.
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: 500

Unique items  

Responses

200 OK

Product report.

Body

application/json
{
    "status": "OK",
    "result": {
        "shopSkus": [
            {
                "shopSku": "string",
                "marketSku": 0,
                "name": "string",
                "price": 0,
                "categoryId": 0,
                "categoryName": "string",
                "weightDimensions": {
                    "length": 0,
                    "width": 0,
                    "height": 0,
                    "weight": 0
                },
                "warehouses": [
                    {
                        "id": 0,
                        "name": "string",
                        "stocks": [
                            {
                                "type": "FIT",
                                "count": 0
                            }
                        ]
                    }
                ],
                "tariffs": [
                    {
                        "type": "AGENCY_COMMISSION",
                        "percent": 0,
                        "amount": 0,
                        "currency": "RUR",
                        "parameters": [
                            {
                                "name": "string",
                                "value": "string"
                            }
                        ]
                    }
                ],
                "pictures": [
                    "string"
                ]
            }
        ]
    }
}

Name

Description

result

Type: GoodsStatsDTO

Product report.

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

GoodsStatsDTO

Product report.

Name

Description

shopSkus*

Type: GoodsStatsGoodsDTO[]

The list of products.
Product information.

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

GoodsStatsGoodsDTO

Product information.

Name

Description

categoryId

Type: integer<int64>

The identifier of the product category on the Market.

categoryName

Type: string

The name of the product category on the Market.

marketSku

Type: integer<int64>

SKU on the Market.

Min value: 1

name

Type: string

Product name.

pictures

Type: string[]

Links (URLs) of product images in good quality.

Min items: 1

price

Type: number

The price of the product in the currency that is set in the seller's office on the Market.

shopSku

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}$

tariffs

Type: TariffDTO[]

Information about the tariffs that you need to pay for Yandex.Market services.

For some services, several different values may be returned. For example, in the FBS model, the cost of a service is SORTING (order processing) depends on the shipping method and the number of orders in the shipment. Read more about the tariffs for services in the Help of the Market for sellers.
Information about the tariffs that you need to pay for Yandex.Market services.

Min items: 1

warehouses

Type: GoodsStatsWarehouseDTO[]

Information about the warehouses where the goods are stored.

The parameter is not received if the product is not in any warehouse.
Information about the warehouse.

Min items: 1

weightDimensions

Type: GoodsStatsWeightDimensionsDTO

Information about the weight and dimensions of the product. If the product is already linked to the card (marketSku), the response will return the dimensions from the Market card, not the dimensions that you provide.

TariffDTO

Information about the tariffs that you need to pay for Yandex.Market services.

Name

Description

amount*

Type: number

The value of the tariff.

currency*

Type: CurrencyType

The currency in which the tariff value 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

parameters*

Type: TariffParameterDTO[]

Tariff calculation parameters.
Details of the calculation of a specific Market service.

type*

Type: TariffType

The Market service for which the tariff is calculated.

Enum: AGENCY_COMMISSION, PAYMENT_TRANSFER, STORAGE, WITHDRAW, SURPLUS, FEE, DELIVERY_TO_CUSTOMER, CROSSREGIONAL_DELIVERY, CROSSREGIONAL_DELIVERY_RETURN, DISPOSAL, SORTING_CENTER_STORAGE, EXPRESS_DELIVERY, FF_XDOC_SUPPLY_BOX, FF_XDOC_SUPPLY_PALLET, SORTING, MIDDLE_MILE, RETURN_PROCESSING, EXPRESS_CANCELLED_BY_PARTNER, CROSSBORDER_DELIVERY, INTAKE_SORTING_BULKY_CARGO, INTAKE_SORTING_SMALL_GOODS, INTAKE_SORTING_DAILY, FF_STORAGE_BILLING, CANCELLED_ORDER_FEE_QI, LATE_ORDER_EXECUTION_FEE_QI

percent

⦸

Type: number

This parameter is deprecated.

Don't use it.

The tariff value is expressed as a percentage.

GoodsStatsWarehouseDTO

Information about the warehouse.

Name

Description

stocks*

Type: WarehouseStockDTO[]

Information about the remaining goods in the warehouse.
Information about the remaining goods.

id

Type: integer<int64>

The warehouse ID.

name

Type: string

The name of the warehouse.

GoodsStatsWeightDimensionsDTO

Information about the weight and dimensions of the product.

If the product is already linked to the card (marketSku), the response will return the dimensions from the Market card, not the dimensions that you provide.

Name

Description

height

Type: number

The height of the product in centimeters.

length

Type: number

The length of the product in centimeters.

weight

Type: number

The weight of the product in kilograms.

width

Type: number

The width of the product in centimeters.

CurrencyType

Currency codes. Possible values:

  • RUR — 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

TariffParameterDTO

Details of the calculation of a specific Market service.

Name

Description

name*

Type: string

The name of the parameter.

value*

Type: string

The value of the parameter.

TariffType

A Market service or an additional tariff to the placement service:

  • AGENCY_COMMISSION — acceptance of the buyer's payment.

  • PAYMENT_TRANSFER — transfer of the buyer's payment.

  • STORAGE — storage of goods in the Market warehouse during the day.

  • SURPLUS — excess storage in the Market warehouse.

  • WITHDRAW — export of goods from the Market warehouse.

  • FEE — product placement on the Market.

  • DELIVERY_TO_CUSTOMER — delivery to the buyer.

  • CROSSREGIONAL_DELIVERY — delivery to the federal district, city or town.

  • CROSSREGIONAL_DELIVERY_RETURN — delivery of non-purchases and refunds.

  • DISPOSAL — disposal.

  • SORTING_CENTER_STORAGE — storage of non-purchases and refunds.

  • EXPRESS_DELIVERY — express delivery to the buyer.

  • FF_XDOC_SUPPLY_BOX — delivery of goods through a transit warehouse (per box).

  • FF_XDOC_SUPPLY_PALLET — delivery of goods through a transit warehouse (per pallet).

  • SORTING — order processing.

  • MIDDLE_MILE — the average mile.

  • RETURN_PROCESSING — processing of non-purchases and refunds.

  • EXPRESS_CANCELLED_BY_PARTNER — cancellation of an order with express delivery.

  • CROSSBORDER_DELIVERY — delivery from abroad.

  • INTAKE_SORTING_BULKY_CARGO — sorting orders with bulky goods that the Market has taken from the seller's warehouse.

  • INTAKE_SORTING_SMALL_GOODS — sorting orders with small-sized goods that the Market has taken from the seller's warehouse.

  • INTAKE_SORTING_DAILY — organization of picking up orders from the seller's warehouse.

  • FF_STORAGE_BILLING — storage of goods in a warehouse.

  • CANCELLED_ORDER_FEE_QI — cancellation of the order is the fault of the seller.

  • LATE_ORDER_EXECUTION_FEE_QI — late shipment or delivery.

Read more about Yandex.Market services in the Help of the Market for sellers.

Type

Description

TariffType

Enum: AGENCY_COMMISSION, PAYMENT_TRANSFER, STORAGE, WITHDRAW, SURPLUS, FEE, DELIVERY_TO_CUSTOMER, CROSSREGIONAL_DELIVERY, CROSSREGIONAL_DELIVERY_RETURN, DISPOSAL, SORTING_CENTER_STORAGE, EXPRESS_DELIVERY, FF_XDOC_SUPPLY_BOX, FF_XDOC_SUPPLY_PALLET, SORTING, MIDDLE_MILE, RETURN_PROCESSING, EXPRESS_CANCELLED_BY_PARTNER, CROSSBORDER_DELIVERY, INTAKE_SORTING_BULKY_CARGO, INTAKE_SORTING_SMALL_GOODS, INTAKE_SORTING_DAILY, FF_STORAGE_BILLING, CANCELLED_ORDER_FEE_QI, LATE_ORDER_EXECUTION_FEE_QI

WarehouseStockDTO

Information about the remaining goods.

Name

Description

count*

Type: integer<int64>

The value of the leftovers.

type*

Type: WarehouseStockType

The type of leftovers.

Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

WarehouseStockType

The type of remaining goods in the warehouse:

  • AVAILABLE (corresponds to the "Available to order" type in the "Stock balances" report in the seller's office on the Market) — an item available for sale.

  • DEFECT (corresponds to the "Marriage" type) — a defective product.

  • EXPIRED (corresponds to the "Expired" type) — an expired product.

  • FIT (corresponds to the "Fit" type) — an item that is available for sale or has already been reserved.

  • FREEZE — the product that is reserved for orders.

  • QUARANTINE (corresponds to the "Quarantine" type) — a product that is temporarily unavailable for sale (for example, the product is being moved from one warehouse to another).

  • UTILIZATION — the product that will be disposed of.

Type

Description

WarehouseStockType

Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

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
Report on the cost of services
Next
Market Prices Report