商品 (Products)

商品目錄——CRUD 端點與所需權限。

檢視 Markdown

商品是你賣的東西——一個商品底下可以有多個價格(例如同一個商品有月繳跟年繳兩種價格)。

GET/api/Product— 列出這個工作區的商品
屬性值
所需權限products:read
Idempotency-Key不需要
參數位置型別必填
pagequeryinteger (int32)
pageSizequeryinteger (int32)
orderByquerystring
orderDirectionquerystring
createdFromquerystring (date-time)
createdToquerystring (date-time)
POST/api/Product— 建立一個新商品
屬性值
所需權限products:write
Idempotency-Key不需要
參數位置型別必填
activebodyboolean
descriptionbodystring
metadatabodyobject
namebodystring
GET/api/Product/{productId}— 讀取單一商品
屬性值
所需權限products:read
Idempotency-Key不需要
參數位置型別必填
productIdpathstring必填
PUT/api/Product/{productId}— 更新商品(名稱、描述、上架狀態)
屬性值
所需權限products:write
Idempotency-Key不需要
參數位置型別必填
productIdpathstring必填
activebodyboolean
descriptionbodystring
metadatabodyobject
namebodystring