跳转到主要内容
POST
创建项目

授权

Authorization
string
header
必填

通过 POST /auth(client_id + client_secret)获取的访问令牌。有效期 300 秒。

请求头

X-Sub-Account
string

执行操作的子账户的 reference。省略时,操作在主账户上执行;保留值 principal 同样解析为主账户,等同于省略该请求头。除 POST /auth 和 /sub-accounts 自身的端点(始终在主账户上操作)外,所有端点均接受该请求头。

可能的错误:404 SUB_ACCOUNT_NOT_FOUND、403 SUB_ACCOUNT_FORBIDDEN、403 SUB_ACCOUNT_SUSPENDED。

要求凭证已启用子账户访问(设置 → 集成 → API 凭证)。该项默认关闭,任何权限都无法替代,FULL_ACCESS 也不例外:未启用时响应为 403 SUB_ACCOUNT_FORBIDDEN。

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
示例:

"loja-centro"

请求体

application/json
name
string
必填

项目名称

Maximum string length: 255
示例:

"Minha Loja"

color
string
必填

项目颜色(十六进制格式)

Pattern: ^#[0-9A-Fa-f]{6}$
示例:

"#3B82F6"

description
string

项目描述

示例:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

项目 logo 的 URL

示例:

"https://example.com/logo.png"

响应

项目创建成功

id
string<uuid>
必填

项目 ID

name
string
必填

项目名称

示例:

"Minha Loja"

color
string
必填

项目颜色(十六进制格式)

示例:

"#3B82F6"

createdAt
string<date-time>
必填

创建时间

description
string

项目描述

示例:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

项目 logo 的 URL

示例:

"https://example.com/logo.png"