SelSup Developers

产品参考数据 · 参考 API

品牌

创建和找到品牌,将它们映射到Ozon和1C,管理标志,

9 终点/api/brand稳定机器可读的描述 ↗
{ }

对于未标志品,首先创建一个专用的无品牌记录,并在产品卡上使用标识符.

/api/brand

准备使用的工作流程

准备使用的工作流程

01

在创建产品之前找到或创建品牌

如果行空,请创建品牌,然后存储产品卡的品牌ID.

  1. 通过查询和count=true来调用GET /api/brand/find.
  2. 在申请中,请比较姓名.
  3. 如果没有匹配,请将 POST /api/brand的名称发送.
  4. 在创建产品模型时使用响应的品牌Id.
02

同步目录与1C

保存1C键在一个CId中,并搜集页面,而不是在一个请求中加载整个目录.

  1. 要求一次50500份记录,按BRANDID排序.
  2. 在第一个请求中设置count=true.
  3. 创建缺失记录或更新BrandOneCId发现的匹配.

数据模型

实际上,马克里斯在布兰德返回了

图像上传后,标志字段会出现.不参与这个API的共享模型字段是故意省略的.

Brand10 字段
brandIdinteger

现行SelSup账户中的品牌标识符.

read-only
namestring

标签名称. 保存时,将领先和后续空间移除.

必填
logoUrlstring

现行标志的公开URL.

read-only
logoSizeinteger

标志量在字节中.

read-only
logoWidthinteger

标志宽度在像素中.

read-only
logoHeightinteger

标志高度在像素中.

read-only
deletedboolean

品牌是否被存档.

ozonNamestring

标签名 标识名

nullable
ozonIdinteger · int64

标识标识符在奥森.

nullable
oneCIdstring

标志表 1C 中的外部标志标志.

nullable

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在error周围的应用逻辑,仅用于显示.

鱼类

稳定机器可读的代码用于集成逻辑.

鱼类

在API代币用户语言中显示准备的消息.

鱼类

服务器在本地化消息模板中插入的值.

localMessage使用了 API代币的用户的lang字段.文档语言和 Accept-Language标题不会改变它;当用户没有语言配置时,使用俄语.

RU用户位置是 ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
CN中文 (cn)
{
  "error": "error_brand_already_exists",
  "localMessage": "品牌 Base 已经存在",
  "params": {
    "name": "Base"
  }
}

终点

终点

GET

找品牌

/api/brand/find
读取访问的标志

列表,搜索和同步的主要终端点. 它将品牌从流动账户返回,并支持稳定的页面化.

i

只有当 count=true 时返回总数.

查询参数

字段类型必填描述
query string 在品牌名称中搜索字符串.
deleted boolean 假的为活跃,不要返回两者.
brandOneCId string 确切的外部1C标识符.
hasOzonId boolean 只有标记为Ozon的品牌才会返回.
limit默认值: 50 integer 每页的记录,高达500个.
page默认值: 1 integer 页面号码从1开始.
count默认值: false boolean 包含总匹配的总数.
sortBy stringNAME, BRANDID 品牌名称的名称,内部标识符的标志.
ascending默认值: false boolean 对于上升的说法是真实的,而下降的说法的说法则是假的.
curl --request GET 'https://api.selsup.ru/api/brand/find?query=Base&limit=50&page=1&count=true&sortBy=NAME&ascending=true' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
字段类型必填描述
rows Brand[] 在当前页面上的品牌.
阵列项结构 Brand
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
total情况: count=true integer 总匹配;只有当count=true时才存在.
page integer 现在的页面号码.
hasNextPage boolean 如果另一个页面可用,
{
  "rows": [
    {
      "brandId": 8124,
      "name": "Base",
      "deleted": false,
      "ozonName": "BASE"
    }
  ],
  "total": 1,
  "page": 1,
  "hasNextPage": false
}
错误3

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

GET

列出所有品牌

/api/brand/all
读取访问的标志

返回账户中的每一个品牌,按姓名排序.

i

对于大型目录和重复同步,使用/find与页面化.

curl --request GET 'https://api.selsup.ru/api/brand/all' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
阵列项结构 Brand[]
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
[
  {
    "brandId": 8124,
    "name": "Base",
    "deleted": false
  },
  {
    "brandId": 8125,
    "name": "Air",
    "deleted": false
  }
]
错误3

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

GET

根据身份证,得到一个品牌

/api/brand/{brandId}
读取访问的标志

通过内部识别符,从经常账户返回品牌.

i

现在的实现返回一个未知的brandId的空值,而不是HTTP 404. 处理空响应.

路径参数

字段类型必填描述
brandId integer 在SelSup中标志标志.
curl --request GET 'https://api.selsup.ru/api/brand/8124' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
对象场 Brand
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
{
  "brandId": 8124,
  "name": "Base",
  "deleted": false,
  "ozonName": "BASE",
  "ozonId": 100582
}
错误3

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

POST

创建一个品牌

/api/brand
具有写入的标志

创建一个品牌在经常账户.

i

名称是以不敏感的方式进行比较; Base和 base被视为相同的品牌.

要求机构

application/json
字段类型必填描述
name string 唯一的,不空的品牌名称.
ozonName string 已知,来自奥森目录的名称.
ozonId integer · int64 在没有先前进口卡的情况下发送卡时,Ozon品牌身份证.
oneCId string 稳定的外部品牌钥匙在1C.
curl --request POST 'https://api.selsup.ru/api/brand' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Base",
  "ozonName": "BASE",
  "ozonId": 100582,
  "oneCId": "BRAND-001"
}'

成功的反应

200
对象场 Brand
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
{
  "brandId": 8124,
  "name": "Base",
  "deleted": false,
  "ozonName": "BASE",
  "ozonId": 100582,
  "oneCId": "BRAND-001"
}
错误6

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

400error_empty_brand_name
未注明品牌名称

名称缺失,空,或仅包含白色空间.

400error_brand_already_exists
品牌 {name} 已经存在

据了解,该账户已经有了不敏感的情况.

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

为了继续使用服务,支付关税.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

PUT

更新一个品牌

/api/brand/{brandId}
具有写入的标志

取代可编辑的品牌字段. ID 来自URL;不要在 JSON 中发送品牌Id.

i

标志字段由单独的终端点管理.

路径参数

字段类型必填描述
brandId integer 品牌更新.

要求机构

application/json
字段类型必填描述
name string 唯一的新名字.
deleted默认值: false boolean 存档状态.
ozonName string 子的品牌名字.
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志标志 1C
curl --request PUT 'https://api.selsup.ru/api/brand/8124' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Base Studio",
  "deleted": false,
  "ozonName": "BASE STUDIO",
  "ozonId": 100582,
  "oneCId": "BRAND-001"
}'

成功的反应

200
对象场 Brand
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
{
  "brandId": 8124,
  "name": "Base Studio",
  "deleted": false,
  "ozonName": "BASE STUDIO",
  "ozonId": 100582,
  "oneCId": "BRAND-001"
}
错误6

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

400error_empty_brand_name
未注明品牌名称

名称缺失,空,或仅包含白色空间.

400error_brand_already_exists
品牌 {name} 已经存在

据了解,该账户已经有了不敏感的情况.

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

为了继续使用服务,支付关税.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

DELETE

删除,存档或恢复品牌

/api/brand/{brandId}
具有写入的标志

在 deleted=true 中,SelSup 尝试硬删除.如果引用存在,它将标志存档. deleted = false 将其恢复.

路径参数

字段类型必填描述
brandId integer 标志标志.

查询参数

字段类型必填描述
deleted boolean 删除或存档的真实;恢复的错误.
curl --request DELETE 'https://api.selsup.ru/api/brand/8124?deleted=true' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
brand_has_been_removed

标志被永久删除.

brand_signed_as_deleted

引用防止删除,所以品牌被存档.

brand_has_been_restore

标志从档案中恢复.

"brand_signed_as_deleted"
错误3

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

POST

装载标志

/api/brand/{brandId}/image
具有写入的标志

装载图像为多部分/form-data. 已有的标志被取代.

i

发送二进制文件;这个终端点不接受JSON.

路径参数

字段类型必填描述
brandId integer 标志标志.

要求机构

multipart/form-data
字段类型必填描述
file binary 支持格式的图像文件.
curl --request POST 'https://api.selsup.ru/api/brand/8124/image' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --form 'file=@./logo.png'

成功的反应

200
对象场 Brand
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
{
  "brandId": 8124,
  "name": "Base",
  "logoUrl": "https://files.selsup.ru/brand/8124.png",
  "logoSize": 18420,
  "logoWidth": 512,
  "logoHeight": 512,
  "deleted": false
}
错误7

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

400error_brand_to_found
未找到品牌 {name} 。

文件保存error代码,正如API所返回的.

400error_wrong_image_format
文件的图像格式不正确: {name}。

文件无法解码为支持的图像格式.

400error_max_upload_size_exceeded
已超过允许的文件大小

多部分请求超过服务器上传限.

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

为了继续使用服务,支付关税.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

DELETE

删除标志

/api/brand/{brandId}/image
具有写入的标志

删除标志文件,并在品牌记录中重置其尺寸.

路径参数

字段类型必填描述
brandId integer 标志标志.
curl --request DELETE 'https://api.selsup.ru/api/brand/8124/image' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
对象场 Brand
字段类型必填描述
brandId integer 现行SelSup账户中的品牌标识符.
name string 标签名称. 保存时,将领先和后续空间移除.
logoUrl string 现行标志的公开URL.
logoSize integer 标志量在字节中.
logoWidth integer 标志宽度在像素中.
logoHeight integer 标志高度在像素中.
deleted默认值: false boolean 品牌是否被存档.
ozonName string 标签名 标识名
ozonId integer · int64 标识标识符在奥森.
oneCId string 标志表 1C 中的外部标志标志.
{
  "brandId": 8124,
  "name": "Base",
  "logoSize": 0,
  "logoWidth": 0,
  "logoHeight": 0,
  "deleted": false
}
错误7

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

400error_brand_to_found
未找到品牌 {name} 。

文件保存error代码,正如API所返回的.

400error_empty_brand_logo
该品牌没有形象

对于没有标志的品牌,要求删除标志.

400error_cant_remove_brand_logo
无法删除品牌形象

存储无法删除文件或更新品牌记录.

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

为了继续使用服务,支付关税.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

POST

合并复制品

/api/brand/{brandId}/merge/{removeBrandId}
具有写入的标志

移动产品模型从删除BrandId到BrandID,然后永久删除删除BandId.

i

取消BrandId是取消的重复文件.

路径参数

字段类型必填描述
brandId integer 标志标志.
removeBrandId integer 复制品牌标识符,要删除.
curl --request POST 'https://api.selsup.ru/api/brand/8124/merge/9012' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200

答案没有身体.

错误5

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

400error_brand_not_found
未找到品牌: {name}。

申请合并的品牌之一在流动账户中不存在.

400error_subscription_expired
你的费率已经过期。支付关税以继续使用该服务。

为了继续使用服务,支付关税.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

Authorization

测试请求的标志

代币存储在本浏览器的本地存储库中,只会在要求的Authorization头上发送到 api.selsup.ru.

试一试

实际请求参数

现场API响应

发送请求查看SelSup的响应.