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/v2/campaigns/{campaignId}/stats/skus

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

Body

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

Name

Description

shopSkus

Type: string[]

The list of your IDs SKU.

Min items: 1

Max items: 500

Unique items: true

Example
[
  "example"
]

Responses

200 OK

Product report.

Body

application/json
{
  "status": "OK",
  "result": {
    "shopSkus": [
      {
        "shopSku": "example",
        "marketSku": 1,
        "name": "example",
        "price": 0.5,
        "categoryId": 0,
        "categoryName": "example",
        "weightDimensions": {},
        "warehouses": [
          null
        ],
        "tariffs": [
          null
        ],
        "pictures": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    The type of response. Possible values:

    • OK — There are no errors.
    • ERROR — an error occurred while processing the request.

    Enum: OK, ERROR

    The standard wrapper for server responses.

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    shopSkus

    Type: object[]

    categoryId

    Type: integer

    The identifier of the product category on the Market.

    categoryName

    Type: string

    The name of the product category on the Market.

    Example: example

    marketSku

    Type: integer

    The ID of the product card on the Market.

    Min value: 1

    name

    Type: string

    Product name.

    Example: example

    pictures

    Type: string[] | null

    Links (URL) product images in good quality.

    Min items: 1

    Unique items: true

    Example
    [
      "example"
    ]
    

    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 — the product ID in your system.

    Usage rules SKU:

    • For each product SKU there must be one.

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

    SKU 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.

    Warning

    Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

    What is SKU and how to assign it

    Min length: 1

    Max length: 255

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

    Example: example

    tariffs

    Type: object[]

    amount

    Type: number

    The value of the tariff.

    currency

    Type: string

    Currency codes:

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

    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: object[]

    name

    Type: string

    The name of the parameter.

    Example: example

    value

    Type: string

    The value of the parameter.

    Example: example

    Tariff calculation parameters.

    Example
    [
      {
        "name": "example",
        "value": "example"
      }
    ]
    

    type

    Type: string

    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 — storage of surpluses 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 items that the Market has picked up from the seller's warehouse.

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

    • INTAKE_SORTING_DAILY — organizing the collection of 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.

    • VOLUME_STORAGE — the cost of storing goods in a warehouse — based on one cubic meter per day.

    • GOODS_ACCEPTANCE — final acceptance of the goods in the warehouse.

    • CARGO_ACCEPTANCE — the initial acceptance of the goods in the warehouse.

    • ORDER_PROCESSING — order processing.

    • WITHDRAW_EXTERNAL — shipping to an external marketplace.

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

    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, VOLUME_STORAGE, GOODS_ACCEPTANCE, CARGO_ACCEPTANCE, ORDER_PROCESSING, WITHDRAW_EXTERNAL

    percent

    Type: number

    The tariff value is expressed as a percentage.

    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 model FBS the cost of the service 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.

    Min items: 1

    Example
    [
      {
        "type": "AGENCY_COMMISSION",
        "percent": 0.5,
        "amount": 0.5,
        "currency": "RUR",
        "parameters": [
          {
            "name": "example",
            "value": "example"
          }
        ]
      }
    ]
    

    warehouses

    Type: object[]

    stocks

    Type: object[]

    count

    Type: integer

    The value of the leftovers.

    type

    Type: string

    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 "Overdue" 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) — An item that is temporarily unavailable for sale (for example, an item is being moved from one warehouse to another).

    • UTILIZATION — the product that will be disposed of.

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

    Information about the remaining goods in the warehouse.

    Example
    [
      {
        "type": "FIT",
        "count": 0
      }
    ]
    

    id

    Type: integer

    The warehouse ID.

    name

    Type: string

    The name of the warehouse.

    Example: example

    Information about the warehouses where the goods are stored.

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

    Min items: 1

    Example
    [
      {
        "id": 0,
        "name": "example",
        "stocks": [
          {
            "type": "FIT",
            "count": 0
          }
        ]
      }
    ]
    

    weightDimensions

    Type: object

    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.

    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.

    Example
    {
      "length": 0.5,
      "width": 0.5,
      "height": 0.5,
      "weight": 0.5
    }
    

    The list of products.

    Example
    [
      {
        "shopSku": "example",
        "marketSku": 1,
        "name": "example",
        "price": 0.5,
        "categoryId": 0,
        "categoryName": "example",
        "weightDimensions": {
          "length": 0.5,
          "width": 0.5,
          "height": 0.5,
          "weight": 0.5
        },
        "warehouses": [
          {
            "id": 0,
            "name": "example",
            "stocks": [
              {}
            ]
          }
        ],
        "tariffs": [
          {
            "type": "AGENCY_COMMISSION",
            "percent": 0.5,
            "amount": 0.5,
            "currency": "RUR",
            "parameters": [
              {}
            ]
          }
        ],
        "pictures": [
          "example"
        ]
      }
    ]
    

    Product report.

    Example
    {
      "shopSkus": [
        {
          "shopSku": "example",
          "marketSku": 1,
          "name": "example",
          "price": 0.5,
          "categoryId": 0,
          "categoryName": "example",
          "weightDimensions": {
            "length": 0.5,
            "width": 0.5,
            "height": 0.5,
            "weight": 0.5
          },
          "warehouses": [
            {
              "id": 0,
              "name": "example",
              "stocks": [
                null
              ]
            }
          ],
          "tariffs": [
            {
              "type": "AGENCY_COMMISSION",
              "percent": 0.5,
              "amount": 0.5,
              "currency": "RUR",
              "parameters": [
                null
              ]
            }
          ],
          "pictures": [
            "example"
          ]
        }
      ]
    }
    
    Example
    {
      "result": {
        "shopSkus": [
          {
            "shopSku": "example",
            "marketSku": 1,
            "name": "example",
            "price": 0.5,
            "categoryId": 0,
            "categoryName": "example",
            "weightDimensions": {
              "length": 0.5,
              "width": 0.5,
              "height": 0.5,
              "weight": 0.5
            },
            "warehouses": [
              {}
            ],
            "tariffs": [
              {}
            ],
            "pictures": [
              "example"
            ]
          }
        ]
      }
    }
    

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    A standard wrapper for server errors.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

401 Unauthorized

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    A standard wrapper for server errors.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    A standard wrapper for server errors.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    A standard wrapper for server errors.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    A standard wrapper for server errors.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    A standard wrapper for server errors.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

No longer supported, please use an alternative and newer version.