目录中有关产品的信息

方法适用于模式:FBY, FBS, Express 和 DBS.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

返回目录中的产品列表,它们在市场上的类别以及每个产品的特性。

它可以用在三种方式:

  • 设置感兴趣的人的名单 SKU;
  • 设置过滤器 — 在这种情况下,结果将逐页返回;
  • 不要发送请求正文以获取目录中所有产品的列表。

要获取产品的类别特征,请使用以下方法 POST v2/businesses/{businessId}/offer-cards.

⚙️ 限制: 每分钟600个请求,每个请求不超过200个产品

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/offer-mappings

Path parameters

Name

Description

businessId

Type: integer

内阁ID。 要找到答案,请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店?

Min value: 1

Query parameters

Name

Description

language

Type: string

接受和返回参数中的值的语言 namedescription.

默认值: RU.

语言:

  • RU — 俄语。
  • UZ — 乌兹别克。

Enum: RU, UZ

limit

Type: integer

每页的值数。

Min value: 1

page_token

Type: string

结果页面的ID。

如果省略该参数,则返回第一页。

我们建议传输输出参数的值 nextPageToken,在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 pagepageSize 它们被忽略了。

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "offerIds": [
    "example"
  ],
  "cardStatuses": [
    "HAS_CARD_CAN_NOT_UPDATE"
  ],
  "categoryIds": [
    0
  ],
  "vendorNames": [
    "example"
  ],
  "tags": [
    "example"
  ],
  "archived": true
}

Name

Description

archived

Type: boolean

按存档中的位置过滤。

传下去 true 以接收存档中的项目。 如果过滤器未填充或通过 false,响应返回不在存档中的项。

cardStatuses

Type: string[] | null

按卡状态过滤。

什么是产品卡?

Min items: 1

Unique items: true

Example
[
  "HAS_CARD_CAN_NOT_UPDATE"
]

categoryIds

Type: integer[] | null

在市场上按类别过滤。

Min items: 1

Unique items: true

Example
[
  0
]

offerIds

Type: string[] | null

需要信息的产品的Id。

此列表仅完整返回。

如果你要求提供特定的资料 SKU,不填写:

  • page_token;
  • limit;
  • cardStatuses;
  • categoryIds;
  • vendorNames;
  • tags;
  • archived.

Min items: 1

Max items: 200

Unique items: true

Example
[
  "example"
]

tags

Type: string[] | null

按标签过滤。

Min items: 1

Unique items: true

Example
[
  "example"
]

vendorNames

Type: string[] | null

按品牌过滤。

Min items: 1

Unique items: true

Example
[
  "example"
]

Responses

200 OK

目录中有关产品的信息。

Body

application/json
{
  "status": "OK",
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offerMappings": [
      {
        "offer": {},
        "mapping": {},
        "showcaseUrls": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

    • OK — 没有错误。
    • ERROR — 处理请求时出错。

    Enum: OK, ERROR

    服务器响应的标准包装器。

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

    result

    Type: object

    offerMappings

    Type: object[]

    mapping

    Type: object

    All of 2 types
    • Type: object

      marketSku

      Type: integer

      市场上的产品卡的ID。

      Min value: 1

      从您的角度来看,市场上适合产品的卡片。 要确定相应卡的ID,请使用机柜中的搜索(产品中心目录上传产品).

      根据验证结果,市场可以将产品链接到更合适的卡。

      Example
      {
        "marketSku": 1
      }
      
    • Type: object

      marketCategoryId

      Type: integer

      品所属的市场上的类别的ID。

      如果市场尚未确定产品类别,则可能会在响应中缺失。

      marketCategoryName

      Type: string

      卡在市场上的类别的名称。

      如果市场尚未确定产品类别,则可能会在响应中缺失。

      Example: example

      marketModelName

      Type: string

      市场上模型的名称。

      如果产品尚未链接到卡,则可能不会包含在响应中。

      Example: example

      marketSkuName

      Type: string

      产品卡的名称。

      如果产品尚未链接到卡,则可能不会包含在响应中。

      Example: example

      Example
      {
        "marketSkuName": "example",
        "marketModelName": "example",
        "marketCategoryId": 0,
        "marketCategoryName": "example"
      }
      

    目录中有关产品的信息。

    Example
    {
      "marketSku": 1,
      "marketSkuName": "example",
      "marketModelName": "example",
      "marketCategoryId": 0,
      "marketCategoryName": "example"
    }
    

    offer

    Type: object

    All of 2 types
    • Type: object

      offerId

      Type: string

      你的 SKU — 系统中的产品ID。

      使用规则 SKU:

      • 对于每个产品 SKU 一定有一个。

      • 已经设置 SKU 它不能被释放并重新用于另一个产品。 每个产品都应该收到一个以前从未在目录中使用过的新标识符。

      SKU 产品可以在市场上的卖方帐户中更改。 阅读如何做到这一点。 在市场对卖家的帮助.

      重要

      值开头和结尾的空格会自动删除。 例如, " SKU123 ""SKU123" 它们将被视为相同的值。

      什么是 SKU 以及如何分配它

      Min length: 1

      Max length: 255

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

      Example: example

      adult

      Type: boolean

      该参数包括产品的18+标签。 仅将其设置为与满足性需求相关的产品。

      age

      Type: object

      ageUnit

      Type: string

      年龄测量单位:

      • YEAR — 年。
      • MONTH — 月份。

      Enum: YEAR, MONTH

      value

      Type: number

      意义。

      Min value: 0

      年龄在指定的测量单位。

      Example
      {
        "value": 0,
        "ageUnit": "YEAR"
      }
      

      barcodes

      Type: string[] | null

      条形码。

      将其指定为数字序列。 密码可以 EAN-13, EAN-8, UPC-A, UPC-E 或 Code 128. 对于书籍 — ISBN.

      对于产品 某些类别和品牌 条形码必须是有效的代码。 GTIN. 请注意:内部条码以2或02开头,以及格式代码 Code 128 他们不是 GTIN.

      【是什么 GTIN](*gtin)

      Min items: 1

      Unique items: true

      Example
      [
        "46012300000000"
      ]
      

      boxCount

      Type: integer

      货位的数量。

      如果产品由多个盒子、包装等组成,则使用此参数。 例如,空调占用两个座位 — 外部和内部单元在两个盒子里。

      对于占据一个位置的产品,不要传递此参数。

      Min value: 1

      category

      Type: string

      相反,使用 marketCategoryId.

      您商店中的产品类别。

      Example: example

      certificates

      Type: string[] | null

      产品文件的编号:证书、符合性声明等.

      您只能通过以下方式将文档的扫描件上传到商家的办公室 指示说明.

      Min items: 1

      Unique items: true

      Example
      [
        "example"
      ]
      

      commodityCodes

      Type: object[]

      code

      Type: string

      产品代码。

      Example: example

      type

      Type: string

      产品代码类型:

      • CUSTOMS_COMMODITY_CODE — 对外经济活动统一商品命名法(HS)中的产品代码 — 没有空格的10或14位数字。
      • IKPU_CODE — 乌兹别克斯坦产品和服务的识别码为17位数字,无空格。

      不要发送相同类型的多个代码。

      Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE

      产品代码。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "type": "CUSTOMS_COMMODITY_CODE"
        }
      ]
      

      condition

      Type: object

      quality

      Type: string

      产品外观:

      • PERFECT — 理想。
      • EXCELLENT — 善乎哉!.
      • GOOD — 好。
      • NOT_SPECIFIED — 未被选中。

      Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

      reason

      Type: string

      产品说明。 详细描述缺陷,它们的明显程度以及在哪里寻找它们。

      Example: example

      type

      Type: string

      标记类型:

      • PREOWNED — 曾经属于另一个人的二手货。
      • SHOWCASESAMPLE — 展示样品。
      • REFURBISHED — 产品的再销售。
      • REDUCTION — 产品有缺陷。
      • RENOVATED — 的还原产物。
      • NOT_SPECIFIED — 未被选中。

      REFURBISHED — 对服装、鞋和配件的特殊意义. 它仅用于此类别的折扣产品。 不使用服装、鞋子和配件的其他值。

      Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED

      折扣产品的状况。

      Example
      {
        "type": "PREOWNED",
        "quality": "PERFECT",
        "reason": "example"
      }
      

      customsCommodityCode

      Type: string

      相反,使用 commodityCodes 与类型 CUSTOMS_COMMODITY_CODE.

      对外经济活动统一商品命名法(HS)中的产品代码 — 没有空格的10或14位数字。

      一定要指出是否有一个。

      Example: 8517610008

      description

      Type: string

      详细的产品说明:例如,它的优点和特点。

      说明中不提供安装和装配说明。 不要使用"折扣","销售","便宜","礼品"(礼品类别除外),"免费","特价","特价","新奇","新","模拟","订单","点击"等字样。 不要提供任何联系信息或链接。

      您可以使用HTML标记来格式化文本:

      • <h>,<h1>,<h2>等等 — 新闻标题;
      • <br>和<p> — 对于换行符;
      • <ol> — 对于编号列表;
      • <ul> — 对于项目符号列表。
      • <李> — 创建列表项(必须在<ol>或<ul>内);
      • <div> — 支持,但不影响文本显示。

      最佳长度 — 400-600个字符。

      建议和规则

      Example: example

      downloadable

      Type: boolean

      数字产品的标志。 指定 true 如果产品是通过电子邮件交付的。

      如何使用数字商品

      guaranteePeriod

      Type: object

      timePeriod

      Type: integer

      指定单位的持续时间。

      timeUnit

      Type: string

      时间测量单元:

      • HOUR — 小时。
      • DAY — 一天。
      • WEEK — 一个星期。
      • MONTH — 月份。
      • YEAR — 年。

      Enum: HOUR, DAY, WEEK, MONTH, YEAR

      comment

      Type: string

      评论。

      Max length: 500

      Example: example

      带有注释的时间段。 注释内容的要求取决于参数用法的上下文,并在包含它的字段的描述中指定。

      Example
      {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      }
      

      lifeTime

      Type: object

      timePeriod

      Type: integer

      指定单位的持续时间。

      timeUnit

      Type: string

      时间测量单元:

      • HOUR — 小时。
      • DAY — 一天。
      • WEEK — 一个星期。
      • MONTH — 月份。
      • YEAR — 年。

      Enum: HOUR, DAY, WEEK, MONTH, YEAR

      comment

      Type: string

      评论。

      Max length: 500

      Example: example

      带有注释的时间段。 注释内容的要求取决于参数用法的上下文,并在包含它的字段的描述中指定。

      Example
      {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      }
      

      manuals

      Type: object[]

      url

      Type: string

      Min length: 1

      Max length: 2000

      Example: example

      title

      Type: string

      将显示在产品卡上的指令的名称。

      Max length: 500

      Example: example

      使用产品的说明列表。

      Min items: 1

      Example
      [
        {
          "url": "example",
          "title": "example"
        }
      ]
      

      manufacturerCountries

      Type: string[] | null

      产品生产的国家。

      写下这些国家的名字,因为它们是写在 名单.

      Min items: 1

      Unique items: true

      Example
      [
        "Россия"
      ]
      

      marketCategoryId

      Type: integer

      您将产品归因于市场上类别的ID。

      传输时始终指示 parameterValues

      如果,在改变特征时,通过 parameterValues 并且不指定 marketCategoryId,特征将被更新,但您将在响应中收到警告(参数 warnings).

      如果您不传递这两个参数,则将使用来自过时参数的信息。 paramscategory,而 marketCategoryId 它将被自动检测到。

      更改类别时,请确保参数中的产品特性及其值 parameterValues 您正在提交一个新的类别.

      您可以使用请求获取市场类别列表。 POST v2/categories/tree.

      Min value: 0

      Exclusive min: true

      name

      Type: string

      根据方案组成名称:类型+品牌或制造商+型号+功能,如果有(例如,颜色,尺寸或重量)和数量在包装中。

      不包括情感特征("命中","超级"等。)以销售条款的名义(例如,"折扣","免费送货"等。). 不要用大写字母写单词。 — 除了成熟的品牌名称和型号。

      最佳长度 — 50-60个字符。

      建议和规则

      Example: Ударная дрель Makita HP1630, 710 Вт

      params

      Type: object[]

      name

      Type: string

      特性的名称。

      它必须与市场上的功能名称相匹配。 您可以从类别的Excel模板或通过查询找到它。 POST v2/category/{categoryId}/parameters.

      Max length: 200

      Example: Wi-Fi

      value

      Type: string

      意义。

      Example: есть

      传输特性时,使用 parameterValues.

      只有特定类别的产品才具有的特性。 — 例如,自行车车轮的直径或鞋底的材料。

      Min items: 1

      Example
      [
        {
          "name": "Wi-Fi",
          "value": "есть"
        }
      ]
      

      pictures

      Type: string[] | null

      产品图片的链接。 第一个链接上的图像被认为是主要的,其他的是额外的。

      连结要求

      • 最多可以有30个链接。
      • 指定整个链接,包括http或https协议。
      • 最大长度 — 512个字符。
      • 俄文字母 URL 阿美。
      • 您可以使用直接链接到图像和Yandex的。磁盘。 Yandex上的链接。必须使用函数共享复制磁盘。 与其他云存储的相对链接和链接 — 它们不起作用。

      https://example-shop.ru/images/sku12345.jpg

      https://yadi.sk/i/NaBoRsimVOLov

      /images/sku12345.jpg

      https://www.dropbox.com/s/818f/tovar.jpg

      与图像的链接必须是永久性的。 不能使用从上载更改为上载的动态链接。

      如果您需要替换图像,请通过新链接上传新图像,并删除到旧图像的链接。 如果您只是使用旧链接替换图像,它将不会更新。

      图像要求

      Min items: 1

      Example
      [
        "example"
      ]
      

      shelfLife

      Type: object

      timePeriod

      Type: integer

      指定单位的持续时间。

      timeUnit

      Type: string

      时间测量单元:

      • HOUR — 小时。
      • DAY — 一天。
      • WEEK — 一个星期。
      • MONTH — 月份。
      • YEAR — 年。

      Enum: HOUR, DAY, WEEK, MONTH, YEAR

      comment

      Type: string

      评论。

      Max length: 500

      Example: example

      带有注释的时间段。 注释内容的要求取决于参数用法的上下文,并在包含它的字段的描述中指定。

      Example
      {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      }
      

      tags

      Type: string[] | null

      商店使用的产品标签。 标签对客户不可见。 您可以按标签对目录中的不同产品进行分组和过滤。 — 例如,同一系列、系列或系列的产品。

      最大标签长度 — 20个字符。 一个产品最多可以有10个标签.

      Min items: 1

      Max items: 50

      Unique items: true

      Example
      [
        "до 500 рублей"
      ]
      

      type

      Type: string

      特殊类型的产品:

      • DEFAULT — 产品,你以前提供了一个特殊的类型,并希望将其删除。
      • MEDICINE — 药品。
      • BOOK — 纸质和电子书。
      • AUDIOBOOK — 有声读物。
      • ARTIST_TITLE — 音乐和视频制作。
      • ON_DEMAND — 定制产品。
      • ALCOHOL — 酒精。

      如果您的产品是 — 书

      在产品规格中指定发布年份。 有关参数的更多信息

      Enum: DEFAULT, MEDICINE, BOOK, AUDIOBOOK, ARTIST_TITLE, ON_DEMAND, ALCOHOL

      vendor

      Type: string

      品牌或制造商的名称。 它应该按照品牌本身的方式来写。

      Example: LEVENHUK

      vendorCode

      Type: string

      从制造商的产品的文章。

      Example: VNDR-0005A

      videos

      Type: string[] | null

      连结(URL)上的产品视频。

      连结要求

      • 指定整个链接,包括http或https协议。
      • 最大长度 — 512个字符。
      • 俄文字母 URL 阿美。
      • 您可以使用视频和Yandex的直接链接。磁盘。 Yandex上的链接。必须使用函数共享复制磁盘。 与其他云存储的相对链接和链接 — 它们不起作用。

      https://example-shop.ru/video/sku12345.avi

      https://yadi.sk/i/NaBoRsimVOLov

      /video/sku12345.avi

      https://www.dropbox.com/s/818f/super-tovar.avi

      视频链接必须是永久性的。 不能使用从上载更改为上载的动态链接。

      如果您需要更换视频,请通过新链接上传新视频,并删除旧视频的链接。 如果您只是使用旧链接替换视频,它将不会更新。

      视频要求

      Min items: 1

      Example
      [
        "example"
      ]
      

      weightDimensions

      Type: object

      height

      Type: number

      包装高度以厘米为单位。

      Min value: 0

      length

      Type: number

      包装长度以厘米为单位。

      Min value: 0

      weight

      Type: number

      以公斤为单位的产品重量,包括包装(毛)。

      Min value: 0

      width

      Type: number

      包装宽度以厘米为单位。

      Min value: 0

      包装的尺寸和产品的重量。

      如果产品占用几个盒子,在测量尺寸之前将它们紧凑地折叠起来。

      多座位货物测量方案

      Example
      {
        "length": 65.55,
        "width": 50.7,
        "height": 20,
        "weight": 1.001
      }
      

      产品的主要参数。

      Example
      {
        "offerId": "example",
        "name": "Ударная дрель Makita HP1630, 710 Вт",
        "marketCategoryId": 0,
        "category": "example",
        "pictures": [
          "example"
        ],
        "videos": [
          "example"
        ],
        "manuals": [
          {
            "url": "example",
            "title": "example"
          }
        ],
        "vendor": "LEVENHUK",
        "barcodes": [
          "46012300000000"
        ],
        "description": "example",
        "manufacturerCountries": [
          "Россия"
        ],
        "weightDimensions": {
          "length": 65.55,
          "width": 50.7,
          "height": 20,
          "weight": 1.001
        },
        "vendorCode": "VNDR-0005A",
        "tags": [
          "до 500 рублей"
        ],
        "shelfLife": {
          "timePeriod": 0,
          "timeUnit": "HOUR",
          "comment": "example"
        },
        "lifeTime": {
          "timePeriod": 0,
          "timeUnit": "HOUR",
          "comment": "example"
        },
        "guaranteePeriod": {
          "timePeriod": 0,
          "timeUnit": "HOUR",
          "comment": "example"
        },
        "customsCommodityCode": "8517610008",
        "commodityCodes": [
          {
            "code": "example",
            "type": "CUSTOMS_COMMODITY_CODE"
          }
        ],
        "certificates": [
          "example"
        ],
        "boxCount": 1,
        "condition": {
          "type": "PREOWNED",
          "quality": "PERFECT",
          "reason": "example"
        },
        "type": "DEFAULT",
        "downloadable": true,
        "adult": true,
        "age": {
          "value": 0,
          "ageUnit": "YEAR"
        },
        "params": [
          {
            "name": "Wi-Fi",
            "value": "есть"
          }
        ]
      }
      
    • Type: object

      additionalExpenses

      Type: object

      All of 2 types
      • Type: object

        currencyId

        Type: string

        货币代码:

        • RUR — 俄罗斯卢布。
        • UAH — 乌克兰格里夫纳。
        • BYR — 白俄罗斯卢布。
        • KZT — 哈萨克斯坦坚戈。
        • UZS — 乌兹别克总和。

        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

        value

        Type: number

        品的价格。

        Min value: 0

        Exclusive min: true

        品的价格。

        Example
        {
          "value": 0,
          "currencyId": "RUR"
        }
        
      • Type: object

        updatedAt

        Type: string<date-time>

        上次更新的时间。

        Example: 2025-01-01T00:00:00Z

        上次更新的时间。

        Example
        {
          "updatedAt": "2025-01-01T00:00:00Z"
        }
        

      指示上次更新时间的价格。

      Example
      {
        "value": 0,
        "currencyId": "RUR",
        "updatedAt": "2025-01-01T00:00:00Z"
      }
      

      archived

      Type: boolean

      产品已存档。

      basicPrice

      Type: object

      All of 2 types
      • Type: object

        All of 2 types
        • Type: object

          currencyId

          Type: string

          货币代码:

          • RUR — 俄罗斯卢布。
          • UAH — 乌克兰格里夫纳。
          • BYR — 白俄罗斯卢布。
          • KZT — 哈萨克斯坦坚戈。
          • UZS — 乌兹别克总和。

          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

          value

          Type: number

          品的价格。

          Min value: 0

          Exclusive min: true

          品的价格。

          Example
          {
            "value": 0,
            "currencyId": "RUR"
          }
          
        • Type: object

          discountBase

          Type: number

          划掉的价格。

          数字必须是整数。 您可以指定折扣从5到99%的价格。

          如果您提供产品折扣,则在每次更新价格时传递此参数。

          Min value: 0

          Exclusive min: true

          Example
          {
            "discountBase": 0
          }
          

        价格与折扣指示.

        Example
        {
          "value": 0,
          "currencyId": "RUR",
          "discountBase": 0
        }
        
      • Type: object

        updatedAt

        Type: string<date-time>

        上次更新的时间。

        Example: 2025-01-01T00:00:00Z

        上次更新的时间。

        Example
        {
          "updatedAt": "2025-01-01T00:00:00Z"
        }
        

      价格包括货币、折扣和上次更新的时间.

      Example
      {
        "value": 0,
        "currencyId": "RUR",
        "discountBase": 0,
        "updatedAt": "2025-01-01T00:00:00Z"
      }
      

      campaigns

      Type: object[]

      campaignId

      Type: integer

      广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

      您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

      • 运动ID;
      • 标签 查询日志 →块中的下拉列表 显示日志.

      ⚠️ 不要把它与:

      • 商店的标识符,显示在商家的个人帐户中。
      • 广告活动。

      Min value: 1

      status

      Type: string

      产品状况:

      • PUBLISHED — 准备出售。
      • CHECKING — 审查中。
      • DISABLED_BY_PARTNER — 被你藏起来了。
      • REJECTED_BY_MARKET — 被拒绝了。
      • DISABLED_AUTOMATICALLY — 修正错误。
      • CREATING_CARD — 正在创建一张卡。
      • NO_CARD — 我需要一张卡片。
      • NO_STOCKS — 没有存货。
      • ARCHIVED — 在档案中。

      每个状态意味着什么?

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

      放置产品的商店列表。

      Min items: 1

      Example
      [
        {
          "campaignId": 1,
          "status": "PUBLISHED"
        }
      ]
      

      cardStatus

      Type: string

      产品卡状态:

      • HAS_CARD_CAN_NOT_UPDATE — 的市场卡。
      • HAS_CARD_CAN_UPDATE — 你可以添加它。
      • HAS_CARD_CAN_UPDATE_ERRORS — 更改尚未被接受。
      • HAS_CARD_CAN_UPDATE_PROCESSING — 变化正在审查中。
      • NO_CARD_NEED_CONTENT — 创建一张卡片。
      • NO_CARD_MARKET_WILL_CREATE — 创建一个市场。
      • NO_CARD_ERRORS — 它不是由于错误而创建的。
      • NO_CARD_PROCESSING — 我们检查数据。
      • NO_CARD_ADD_TO_CAMPAIGN — 将产品放在商店里。

      Enum: HAS_CARD_CAN_NOT_UPDATE, HAS_CARD_CAN_UPDATE, HAS_CARD_CAN_UPDATE_ERRORS, HAS_CARD_CAN_UPDATE_PROCESSING, NO_CARD_NEED_CONTENT, NO_CARD_MARKET_WILL_CREATE, NO_CARD_ERRORS, NO_CARD_PROCESSING, NO_CARD_ADD_TO_CAMPAIGN

      groupId

      Type: string

      产品组的标识符。

      组合在一起的产品将具有相同的标识符。

      如何将产品组合在卡片上

      Example: example

      mediaFiles

      Type: object

      firstVideoAsCover

      Type: boolean

      使用卡中的第一个视频作为视频背景。

      传下去 true 为第一视频作为视频背景,或 false 使视频背景不显示在产品配置文件中。

      manuals

      Type: object[]

      title

      Type: string

      媒体文件的名称。

      Example: example

      uploadState

      Type: string

      媒体文件下载状态:

      • UPLOADING — 装货了。
      • UPLOADED — 上传成功。
      • FAILED — 下载过程中发生错误。 请稍后再试。

      Enum: UPLOADING, UPLOADED, FAILED

      url

      Type: string

      Min length: 1

      Max length: 2000

      Example: example

      产品使用指南。

      Min items: 1

      Example
      [
        {
          "url": "example",
          "title": "example",
          "uploadState": "UPLOADING"
        }
      ]
      

      pictures

      Type: object[]

      title

      Type: string

      媒体文件的名称。

      Example: example

      uploadState

      Type: string

      媒体文件下载状态:

      • UPLOADING — 装货了。
      • UPLOADED — 上传成功。
      • FAILED — 下载过程中发生错误。 请稍后再试。

      Enum: UPLOADING, UPLOADED, FAILED

      url

      Type: string

      Min length: 1

      Max length: 2000

      Example: example

      产品图像。

      Min items: 1

      Example
      [
        {
          "url": "example",
          "title": "example",
          "uploadState": "UPLOADING"
        }
      ]
      

      videos

      Type: object[]

      title

      Type: string

      媒体文件的名称。

      Example: example

      uploadState

      Type: string

      媒体文件下载状态:

      • UPLOADING — 装货了。
      • UPLOADED — 上传成功。
      • FAILED — 下载过程中发生错误。 请稍后再试。

      Enum: UPLOADING, UPLOADED, FAILED

      url

      Type: string

      Min length: 1

      Max length: 2000

      Example: example

      产品的视频文件。

      Min items: 1

      Example
      [
        {
          "url": "example",
          "title": "example",
          "uploadState": "UPLOADING"
        }
      ]
      

      有关产品的媒体文件的信息。

      Example
      {
        "firstVideoAsCover": true,
        "videos": [
          {
            "url": "example",
            "title": "example",
            "uploadState": "UPLOADING"
          }
        ],
        "pictures": [
          {
            "url": "example",
            "title": "example",
            "uploadState": "UPLOADING"
          }
        ],
        "manuals": [
          {
            "url": "example",
            "title": "example",
            "uploadState": "UPLOADING"
          }
        ]
      }
      

      purchasePrice

      Type: object

      All of 2 types
      • Type: object

        currencyId

        Type: string

        货币代码:

        • RUR — 俄罗斯卢布。
        • UAH — 乌克兰格里夫纳。
        • BYR — 白俄罗斯卢布。
        • KZT — 哈萨克斯坦坚戈。
        • UZS — 乌兹别克总和。

        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

        value

        Type: number

        品的价格。

        Min value: 0

        Exclusive min: true

        品的价格。

        Example
        {
          "value": 0,
          "currencyId": "RUR"
        }
        
      • Type: object

        updatedAt

        Type: string<date-time>

        上次更新的时间。

        Example: 2025-01-01T00:00:00Z

        上次更新的时间。

        Example
        {
          "updatedAt": "2025-01-01T00:00:00Z"
        }
        

      指示上次更新时间的价格。

      Example
      {
        "value": 0,
        "currencyId": "RUR",
        "updatedAt": "2025-01-01T00:00:00Z"
      }
      

      sellingPrograms

      Type: object[]

      sellingProgram

      Type: string

      工作模式:

      • FBY — FBY.
      • FBS — FBS.
      • DBS — DBS.
      • EXPRESS — Express.

      Enum: FBY, FBS, DBS, EXPRESS, LAAS

      status

      Type: string

      可用性或不可用性的信息。

      • FINE — 可用。
      • REJECT — 不可用。

      Enum: FINE, REJECT

      有关产品可用的放置模型的信息。

      Min items: 1

      Example
      [
        {
          "sellingProgram": "FBY",
          "status": "FINE"
        }
      ]
      
      Example
      {
        "basicPrice": {
          "value": 0,
          "currencyId": "RUR",
          "discountBase": 0,
          "updatedAt": "2025-01-01T00:00:00Z"
        },
        "purchasePrice": {
          "value": 0,
          "currencyId": "RUR",
          "updatedAt": "2025-01-01T00:00:00Z"
        },
        "additionalExpenses": {
          "value": 0,
          "currencyId": "RUR",
          "updatedAt": "2025-01-01T00:00:00Z"
        },
        "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
        "campaigns": [
          {
            "campaignId": 1,
            "status": "PUBLISHED"
          }
        ],
        "sellingPrograms": [
          {
            "sellingProgram": "FBY",
            "status": "FINE"
          }
        ],
        "mediaFiles": {
          "firstVideoAsCover": true,
          "videos": [
            {
              "url": "example",
              "title": "example",
              "uploadState": "UPLOADING"
            }
          ],
          "pictures": [
            {
              "url": "example",
              "title": "example",
              "uploadState": "UPLOADING"
            }
          ],
          "manuals": [
            {
              "url": "example",
              "title": "example",
              "uploadState": "UPLOADING"
            }
          ]
        },
        "archived": true,
        "groupId": "example"
      }
      

    产品参数。

    Example
    {
      "offerId": "example",
      "name": "Ударная дрель Makita HP1630, 710 Вт",
      "marketCategoryId": 0,
      "category": "example",
      "pictures": [
        "example"
      ],
      "videos": [
        "example"
      ],
      "manuals": [
        {
          "url": "example",
          "title": "example"
        }
      ],
      "vendor": "LEVENHUK",
      "barcodes": [
        "46012300000000"
      ],
      "description": "example",
      "manufacturerCountries": [
        "Россия"
      ],
      "weightDimensions": {
        "length": 65.55,
        "width": 50.7,
        "height": 20,
        "weight": 1.001
      },
      "vendorCode": "VNDR-0005A",
      "tags": [
        "до 500 рублей"
      ],
      "shelfLife": {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      },
      "lifeTime": {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      },
      "guaranteePeriod": {
        "timePeriod": 0,
        "timeUnit": "HOUR",
        "comment": "example"
      },
      "customsCommodityCode": "8517610008",
      "commodityCodes": [
        {
          "code": "example",
          "type": "CUSTOMS_COMMODITY_CODE"
        }
      ],
      "certificates": [
        "example"
      ],
      "boxCount": 1,
      "condition": {
        "type": "PREOWNED",
        "quality": "PERFECT",
        "reason": "example"
      },
      "type": "DEFAULT",
      "downloadable": true,
      "adult": true,
      "age": {
        "value": 0,
        "ageUnit": "YEAR"
      },
      "params": [
        {
          "name": "Wi-Fi",
          "value": "есть"
        }
      ],
      "basicPrice": {
        "value": 0,
        "currencyId": "RUR",
        "discountBase": 0,
        "updatedAt": "2025-01-01T00:00:00Z"
      },
      "purchasePrice": {
        "value": 0,
        "currencyId": "RUR",
        "updatedAt": "2025-01-01T00:00:00Z"
      },
      "additionalExpenses": {
        "value": 0,
        "currencyId": "RUR",
        "updatedAt": "2025-01-01T00:00:00Z"
      },
      "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
      "campaigns": [
        {
          "campaignId": 1,
          "status": "PUBLISHED"
        }
      ],
      "sellingPrograms": [
        {
          "sellingProgram": "FBY",
          "status": "FINE"
        }
      ],
      "mediaFiles": {
        "firstVideoAsCover": true,
        "videos": [
          {
            "url": "example",
            "title": "example",
            "uploadState": "UPLOADING"
          }
        ],
        "pictures": [
          {
            "url": "example",
            "title": "example",
            "uploadState": "UPLOADING"
          }
        ],
        "manuals": [
          {
            "url": "example",
            "title": "example",
            "uploadState": "UPLOADING"
          }
        ]
      },
      "archived": true,
      "groupId": "example"
    }
    

    showcaseUrls

    Type: object[]

    showcaseType

    Type: string

    展柜类型:

    Enum: B2B, B2C

    showcaseUrl

    Type: string

    产品链接。

    Example: example

    链接到同一产品在市场的不同店面。

    Min items: 1

    Example
    [
      {
        "showcaseType": "B2B",
        "showcaseUrl": "example"
      }
    ]
    

    有关产品的信息。

    Example
    [
      {
        "offer": {
          "offerId": "example",
          "name": "Ударная дрель Makita HP1630, 710 Вт",
          "marketCategoryId": 0,
          "category": "example",
          "pictures": [
            "example"
          ],
          "videos": [
            "example"
          ],
          "manuals": [
            {}
          ],
          "vendor": "LEVENHUK",
          "barcodes": [
            "46012300000000"
          ],
          "description": "example",
          "manufacturerCountries": [
            "Россия"
          ],
          "weightDimensions": {
            "length": 65.55,
            "width": 50.7,
            "height": 20,
            "weight": 1.001
          },
          "vendorCode": "VNDR-0005A",
          "tags": [
            "до 500 рублей"
          ],
          "shelfLife": {
            "timePeriod": 0,
            "timeUnit": "HOUR",
            "comment": "example"
          },
          "lifeTime": {
            "timePeriod": 0,
            "timeUnit": "HOUR",
            "comment": "example"
          },
          "guaranteePeriod": {
            "timePeriod": 0,
            "timeUnit": "HOUR",
            "comment": "example"
          },
          "customsCommodityCode": "8517610008",
          "commodityCodes": [
            {}
          ],
          "certificates": [
            "example"
          ],
          "boxCount": 1,
          "condition": {
            "type": "PREOWNED",
            "quality": "PERFECT",
            "reason": "example"
          },
          "type": "DEFAULT",
          "downloadable": true,
          "adult": true,
          "age": {
            "value": 0,
            "ageUnit": "YEAR"
          },
          "params": [
            {}
          ],
          "basicPrice": {},
          "purchasePrice": {},
          "additionalExpenses": {},
          "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
          "campaigns": [
            {}
          ],
          "sellingPrograms": [
            {}
          ],
          "mediaFiles": {
            "firstVideoAsCover": true,
            "videos": [
              null
            ],
            "pictures": [
              null
            ],
            "manuals": [
              null
            ]
          },
          "archived": true,
          "groupId": "example"
        },
        "mapping": {
          "marketSku": 1,
          "marketSkuName": "example",
          "marketModelName": "example",
          "marketCategoryId": 0,
          "marketCategoryName": "example"
        },
        "showcaseUrls": [
          {
            "showcaseType": "B2B",
            "showcaseUrl": "example"
          }
        ]
      }
    ]
    

    paging

    Type: object

    All of 2 types
    • Type: object

      nextPageToken

      Type: string

      下一个结果页面的ID。

      Example: example

      下一页的ID。

      Example
      {
        "nextPageToken": "example"
      }
      
    • Type: object

      prevPageToken

      Type: string

      上一个结果页面的ID。

      Example: example

      Example
      {
        "prevPageToken": "example"
      }
      

    有关结果页的信息。

    Example
    {
      "nextPageToken": "example",
      "prevPageToken": "example"
    }
    

    有关产品的信息。

    Example
    {
      "paging": {
        "nextPageToken": "example",
        "prevPageToken": "example"
      },
      "offerMappings": [
        {
          "offer": {
            "offerId": "example",
            "name": "Ударная дрель Makita HP1630, 710 Вт",
            "marketCategoryId": 0,
            "category": "example",
            "pictures": [
              null
            ],
            "videos": [
              null
            ],
            "manuals": [
              null
            ],
            "vendor": "LEVENHUK",
            "barcodes": [
              null
            ],
            "description": "example",
            "manufacturerCountries": [
              null
            ],
            "weightDimensions": {},
            "vendorCode": "VNDR-0005A",
            "tags": [
              null
            ],
            "shelfLife": {},
            "lifeTime": {},
            "guaranteePeriod": {},
            "customsCommodityCode": "8517610008",
            "commodityCodes": [
              null
            ],
            "certificates": [
              null
            ],
            "boxCount": 1,
            "condition": {},
            "type": "DEFAULT",
            "downloadable": true,
            "adult": true,
            "age": {},
            "params": [
              null
            ],
            "basicPrice": {},
            "purchasePrice": {},
            "additionalExpenses": {},
            "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
            "campaigns": [
              null
            ],
            "sellingPrograms": [
              null
            ],
            "mediaFiles": {},
            "archived": true,
            "groupId": "example"
          },
          "mapping": {
            "marketSku": 1,
            "marketSkuName": "example",
            "marketModelName": "example",
            "marketCategoryId": 0,
            "marketCategoryName": "example"
          },
          "showcaseUrls": [
            {
              "showcaseType": "B2B",
              "showcaseUrl": "example"
            }
          ]
        }
      ]
    }
    
    Example
    {
      "result": {
        "paging": {
          "nextPageToken": "example",
          "prevPageToken": "example"
        },
        "offerMappings": [
          {
            "offer": {},
            "mapping": {},
            "showcaseUrls": [
              {}
            ]
          }
        ]
      }
    }
    

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

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

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

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

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

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

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

404 Not Found

找不到请求的资源。 有关错误的更多信息

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

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

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

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

500 Internal Server Error

Yandex中的内部错误。 市场。 有关错误的更多信息

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

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

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

什么是GTIN?
[医]GTIN — 这是在单个国际数据库中分配给产品的唯一编号。 GS1. 此编号生成EAN、UPC或ISBN条形码。

如何确保产品在数据库中
你可以在 验证页面 在GS1协会的网站上。 如果未找到产品,请向供应商索取GTIN代码。

如何为您的产品获取GTIN
要接收GTIN代码,制造商需要加入GS1协会并注册产品。