跳至內容
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"

附加欄位: 否