SelSup Developers

公共的 API · 参考 API

设置

设置的终点,包括精确的路线,参数,请求机器和可扩展的响应方案.

终点: 3/api/property稳定机器可读的描述 ↗
{ }

通过可编辑的独立合同来支持本页面. 在生产使用之前,验证使用测试数据的写作操作.

/api/property

准备使用的工作流程

准备使用的工作流程

01

开始使用设置

使用专用API代币,首先验证测试数据的读取操作.

  1. 保存代币服务器侧,然后将其发送到Authorization标题中.
  2. 检查所需参数,并扩大请求或响应方案.
  3. 在应用错误中处理HTTP状态和稳定的error字段.

数据模型

数据结构

模型在此列出一次,并且可以直接从使用它们的终端点扩展.

Property6 字段
organizationIdinteger · int64

组织身份证.

clientIdinteger · int64

客户身份证.

read-only
componentstring

组件.

namestring

姓名.

valuestring

价值.

valueNamestring

值名字

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在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"
  }
}

终点

终点

PUT

放弃财产

/api/property/
具有写入的标志

使用 PUT /api/property/. 设置物业

要求机构

application/json
对象场Property
字段类型必填描述
organizationId integer · int64 否 组织身份证.
clientId integer · int64 否 客户身份证.
component string 否 组件.
name string 否 姓名.
value string 否 价值.
valueName string 否 值名字
curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

成功的反应

200

答案没有身体.

错误7

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_cant_extract_tariffs
无法获取费率。请联系支持团队

应用逻辑中使用稳定的error_cant_extract_tariffs代码;localMessage包含上述翻译.

400error_invalid_currency_source
不支持指定的汇率来源

应用逻辑中使用稳定的error_invalid_currency_source代码;localMessage包含上述翻译.

400error_invalid_stock_distribution_rules
库存分配规则无效:请检查 0 到 1 的比例和库存阈值。

应用逻辑中使用稳定的error_invalid_stock_distribution_rules代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

GET

走吧

/api/property/{organizationId}/{component}
读取访问的标志

开始使用GET/api/property/{organizationId}/{component}.

路径参数

字段类型必填描述
organizationId integer · int64 是 组织身份证.
component string 是 组件.
curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
"string"
错误32

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_base_creating
您的账户正在创建中,请等待几分钟直至账户完全创建

应用逻辑中使用稳定的error_base_creating代码;localMessage包含上述翻译.

400error_cant_extract_tariffs
无法获取费率。请联系支持团队

应用逻辑中使用稳定的error_cant_extract_tariffs代码;localMessage包含上述翻译.

400error_cant_receive_stocks
无法获取库存

应用逻辑中使用稳定的error_cant_receive_stocks代码;localMessage包含上述翻译.

400error_client_branding_failed
无法加载或保存品牌设置。

应用逻辑中使用稳定的error_client_branding_failed代码;localMessage包含上述翻译.

400error_fbs_marking_code_unsupported
无支持的FBS标记码

应用逻辑中使用稳定的error_fbs_marking_code_unsupported代码;localMessage包含上述翻译.

400error_fulfillment_client_access_denied
Fulfillment client access denied

应用逻辑中使用稳定的error_fulfillment_client_access_denied代码;localMessage包含上述翻译.

400error_fulfillment_client_contract_required
请先接受合同以访问操作。

应用逻辑中使用稳定的error_fulfillment_client_contract_required代码;localMessage包含上述翻译.

400error_fulfillment_request_invalid
执行请求无效

应用逻辑中使用稳定的error_fulfillment_request_invalid代码;localMessage包含上述翻译.

400error_header_logo_upload_failed
Could not upload the logo. Please try again.

应用逻辑中使用稳定的error_header_logo_upload_failed代码;localMessage包含上述翻译.

400error_income_not_found
未找到供应商订单号{id}。

应用逻辑中使用稳定的error_income_not_found代码;localMessage包含上述翻译.

400error_integration_cell_mapping_invalid
整合细胞映射不有效

应用逻辑中使用稳定的error_integration_cell_mapping_invalid代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_no_price_for_order_product
未指定价格的项目: {name}。

应用逻辑中使用稳定的error_no_price_for_order_product代码;localMessage包含上述翻译.

400error_no_quantity_for_order_product
未指定项目数量: {name}。

应用逻辑中使用稳定的error_no_quantity_for_order_product代码;localMessage包含上述翻译.

400error_order_not_found
未找到订单

应用逻辑中使用稳定的error_order_not_found代码;localMessage包含上述翻译.

400error_organization_create_failed
创建组织时出现问题。 请联系支持

应用逻辑中使用稳定的error_organization_create_failed代码;localMessage包含上述翻译.

400error_organization_exists
已经成立了一个组织

应用逻辑中使用稳定的error_organization_exists代码;localMessage包含上述翻译.

400error_organization_not_found
没有发现任何组织

应用逻辑中使用稳定的error_organization_not_found代码;localMessage包含上述翻译.

400error_ozon_fbo_workflow_not_found
未找到 Ozon FBO 工作流 {id}

应用逻辑中使用稳定的error_ozon_fbo_workflow_not_found代码;localMessage包含上述翻译.

400error_reload
授权会话已过期,刷新你的浏览器页面。如果更新没有帮助,尝试删除该网站的cookies

应用逻辑中使用稳定的error_reload代码;localMessage包含上述翻译.

400error_settlement_invalid
结算无效

应用逻辑中使用稳定的error_settlement_invalid代码;localMessage包含上述翻译.

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

应用逻辑中使用稳定的error_subscription_expired代码;localMessage包含上述翻译.

400error_supply_not_found
没有发现供应: {name}。

应用逻辑中使用稳定的error_supply_not_found代码;localMessage包含上述翻译.

400error_token_expired_or_revoked
API令牌被撤销或输入错误

应用逻辑中使用稳定的error_token_expired_or_revoked代码;localMessage包含上述翻译.

400error_transport_waybill_invalid
请检查电子运输单数据。

应用逻辑中使用稳定的error_transport_waybill_invalid代码;localMessage包含上述翻译.

400error_transport_waybill_source
此发货或供货无法创建电子运输单。

应用逻辑中使用稳定的error_transport_waybill_source代码;localMessage包含上述翻译.

400error_user_does_not_have_this_organization
用户无权访问此组织

应用逻辑中使用稳定的error_user_does_not_have_this_organization代码;localMessage包含上述翻译.

400error_warehouse_not_found
没有发现仓库

应用逻辑中使用稳定的error_warehouse_not_found代码;localMessage包含上述翻译.

400error_warehouse_setup_unavailable
存储器设置不可

应用逻辑中使用稳定的error_warehouse_setup_unavailable代码;localMessage包含上述翻译.

GET

列表

/api/property/list/{component}
读取访问的标志

使用 GET /api/property/list/{component}.的列表

路径参数

字段类型必填描述
component string 是 组件.

查询参数

字段类型必填描述
organizationId integer · int64 否 组织身份证.
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

成功的反应

200
阵列项结构 Property[]
字段类型必填描述
organizationId integer · int64 否 组织身份证.
clientId integer · int64 否 客户身份证.
component string 否 组件.
name string 否 姓名.
value string 否 价值.
valueName string 否 值名字
[
  "string"
]
错误34

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

401auth_required
需要进行认证

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

400error_access_denied
拒绝访问

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

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

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

400error_bad_request
请求格式不正确

应用逻辑中使用稳定的error_bad_request代码;localMessage包含上述翻译.

400error_base_creating
您的账户正在创建中,请等待几分钟直至账户完全创建

应用逻辑中使用稳定的error_base_creating代码;localMessage包含上述翻译.

400error_cabinet_access_denied
无法访问此工作空间。

应用逻辑中使用稳定的error_cabinet_access_denied代码;localMessage包含上述翻译.

400error_cant_extract_tariffs
无法获取费率。请联系支持团队

应用逻辑中使用稳定的error_cant_extract_tariffs代码;localMessage包含上述翻译.

400error_container_log_read_failed
集装箱记录读取失败

应用逻辑中使用稳定的error_container_log_read_failed代码;localMessage包含上述翻译.

400error_container_log_request_invalid
容器日志请求无效

应用逻辑中使用稳定的error_container_log_request_invalid代码;localMessage包含上述翻译.

400error_empty_first_name
未指定 名称

应用逻辑中使用稳定的error_empty_first_name代码;localMessage包含上述翻译.

400error_empty_last_name
未说明 姓氏

应用逻辑中使用稳定的error_empty_last_name代码;localMessage包含上述翻译.

400error_empty_organization_form
未指定组织形式

应用逻辑中使用稳定的error_empty_organization_form代码;localMessage包含上述翻译.

400error_empty_organization_inn
该组织的TIN码丢失

应用逻辑中使用稳定的error_empty_organization_inn代码;localMessage包含上述翻译.

400error_empty_organization_name
没有说明该组织的名称

应用逻辑中使用稳定的error_empty_organization_name代码;localMessage包含上述翻译.

400error_empty_position_name
未注明职称

应用逻辑中使用稳定的error_empty_position_name代码;localMessage包含上述翻译.

400error_fulfillment_client_access_denied
Fulfillment client access denied

应用逻辑中使用稳定的error_fulfillment_client_access_denied代码;localMessage包含上述翻译.

400error_fulfillment_client_contract_required
请先接受合同以访问操作。

应用逻辑中使用稳定的error_fulfillment_client_contract_required代码;localMessage包含上述翻译.

400error_fulfillment_document_error
无法生成文档。请检查参数和操作内容。

应用逻辑中使用稳定的error_fulfillment_document_error代码;localMessage包含上述翻译.

400error_fulfillment_request_invalid
执行请求无效

应用逻辑中使用稳定的error_fulfillment_request_invalid代码;localMessage包含上述翻译.

400error_income_not_found
未找到供应商订单号{id}。

应用逻辑中使用稳定的error_income_not_found代码;localMessage包含上述翻译.

400error_max_page
页码不能大于100,000

应用逻辑中使用稳定的error_max_page代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的error_no_client代码;localMessage包含上述翻译.

400error_no_price_for_order_product
未指定价格的项目: {name}。

应用逻辑中使用稳定的error_no_price_for_order_product代码;localMessage包含上述翻译.

400error_no_quantity_for_order_product
未指定项目数量: {name}。

应用逻辑中使用稳定的error_no_quantity_for_order_product代码;localMessage包含上述翻译.

400error_order_not_found
未找到订单

应用逻辑中使用稳定的error_order_not_found代码;localMessage包含上述翻译.

400error_organization_create_failed
创建组织时出现问题。 请联系支持

应用逻辑中使用稳定的error_organization_create_failed代码;localMessage包含上述翻译.

400error_organization_exists
已经成立了一个组织

应用逻辑中使用稳定的error_organization_exists代码;localMessage包含上述翻译.

400error_position_exists
已经有一个叫这个名字的职位

应用逻辑中使用稳定的error_position_exists代码;localMessage包含上述翻译.

400error_reload
授权会话已过期,刷新你的浏览器页面。如果更新没有帮助,尝试删除该网站的cookies

应用逻辑中使用稳定的error_reload代码;localMessage包含上述翻译.

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

应用逻辑中使用稳定的error_subscription_expired代码;localMessage包含上述翻译.

400error_warehouse_not_found
没有发现仓库

应用逻辑中使用稳定的error_warehouse_not_found代码;localMessage包含上述翻译.

400error_wrong_crm_token
CRM令牌错误

应用逻辑中使用稳定的error_wrong_crm_token代码;localMessage包含上述翻译.

400error_wrong_inn
不正确的公司TIN,10或12位数的长度

应用逻辑中使用稳定的error_wrong_inn代码;localMessage包含上述翻译.

400error_wrong_version
指定的版本不正确

应用逻辑中使用稳定的error_wrong_version代码;localMessage包含上述翻译.

Authorization

测试请求的标志

获取 API 令牌

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

试一试

实际请求参数

现场API响应

发送请求查看SelSup的响应.