跳至内容
ShopentlyLearn
简体中文

数据架构: 通用模型

数据架构: 通用模型. API 接收或返回的数据字段、类型和约束。

数据架构

结构化错误信息

ApiError · 架构 · 数据架构: 通用模型
code字符串必填

稳定的机器可读代码。

约束
enum
["request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]
示例: "authentication.invalid_credentials"
fields数组 <FieldError > null可选

各字段的验证错误。

示例: null
message字符串必填

面向人的说明；程序逻辑应使用错误代码。

示例: "The credentials are invalid."

附加字段: 否

创建 — 品牌 — 响应

ApiResponse_MutationData_ · API 接收或返回的数据字段、类型和约束。
dataMutationData 必填

响应示例 · MutationData.

示例: {"deleted":false,"id":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

响应元数据。

示例: {"request_id":"example"}

附加字段: 否

响应元数据

ContextMeta · 架构 · 数据架构: 通用模型
locale字符串必填

本次请求选择的语言。

示例: "en"
market_code字符串必填

上下文端点返回的市场代码。

示例: "PL"
market_id字符串必填

上下文端点返回的市场标识符。

示例: "example"
request_id字符串必填

申请标识符；在响应元数据中表示 HTTP 请求标识符。

minLength: 1maxLength: 100
示例: "example"

附加字段: 否

响应元数据

ContextPageMeta · 架构 · 数据架构: 通用模型
locale字符串必填

本次请求选择的语言。

示例: "en"
market_code字符串必填

上下文端点返回的市场代码。

示例: "PL"
market_id字符串必填

上下文端点返回的市场标识符。

示例: "example"
paginationPagination 必填

游标分页元数据。

示例: {"has_more":false,"limit":20,"next_cursor":null}
request_id字符串必填

申请标识符；在响应元数据中表示 HTTP 请求标识符。

minLength: 1maxLength: 100
示例: "example"

附加字段: 否

错误目录

ErrorResponse · API 接收或返回的数据字段、类型和约束。
errorApiError 必填

结构化错误信息。

示例: {"code":"authentication.invalid_credentials","fields":null,"message":"The credentials are invalid."}
metaRequestMeta 必填

响应元数据。

示例: {"request_id":"example-request"}

附加字段: 否

各字段的验证错误

FieldError · 架构 · 数据架构: 通用模型
code字符串必填

稳定的机器可读代码。

约束
enum
["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]
field字符串必填

与验证错误相关的字段。

minLength: 1maxLength: 128
location字符串必填

位置信息。

约束
enum
["path", "query", "header", "body"]

附加字段: 否

加入响应中所示附加组成部分之前的金额

MoneyData · 架构 · 数据架构: 通用模型
amount字符串必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

示例: "0.00"
currency字符串必填

金额的币种代码。

约束
pattern
"^[A-Z]{3}$"
示例: "PLN"
minor_units整数必填

币种使用的小数位数。

minimum: 0maximum: 4
示例: 2

附加字段: 否

创建 — 品牌 — 响应

MutationData · API 接收或返回的数据字段、类型和约束。
deleted布尔值必填

是否已执行删除。

示例: false
id字符串必填

资源标识符；请保留返回的原值。 (MutationData).

示例: "example"
version整数 null必填

用于并发控制的资源版本。

示例: 1

附加字段: 否

响应元数据

PageMeta · 架构 · 数据架构: 通用模型
paginationPagination 必填

游标分页元数据。

示例: {"has_more":false,"limit":20,"next_cursor":null}
request_id字符串必填

申请标识符；在响应元数据中表示 HTTP 请求标识符。

minLength: 1maxLength: 100
示例: "example"

附加字段: 否

游标分页元数据

Pagination · 架构 · 数据架构: 通用模型
has_more布尔值必填

是否还有下一页。

示例: false
limit整数必填

此页记录数上限。

minimum: 1maximum: 100
示例: 20
next_cursor字符串 null必填

下一页续页值，或 null。

示例: null

附加字段: 否

响应元数据

RequestMeta · 架构 · 数据架构: 通用模型
request_id字符串必填

申请标识符；在响应元数据中表示 HTTP 请求标识符。

minLength: 1maxLength: 100
示例: "example"

附加字段: 否