管理后台 (1.0.0)

Download OpenAPI specification:

License:

提供管理员管理的所有功能

Open API / Purchase Order

PurchaseSupplementTradeNoAPI

Create a supplement pay order. Purchase-order supplements and bag-order supplements must be submitted separately. Then call /open-api/pay/wallet/pay with the returned paymentId.

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
externalUserId
required
string <= 64 characters
orderExpensesNoList
required
Array of strings non-empty

Expense nos from supplement/list. Do not mix purchase and bag expense nos in one call.

Responses

Request samples

Content type
application/json
{
  • "externalUserId": "string",
  • "orderExpensesNoList": [
    ]
}

PurchaseSupplementListAPI

List outstanding supplement (extra-payment) bills. Auto-debit is the normal path when member repayment auth is on; call this only when auto-debit failed (insufficient balance or auth off).

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
externalUserId
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "externalUserId": "shopify_10086"
}

PurchaseQuoteAPI

Server-side live pricing. Client-provided prices are ignored. Does not create an order.

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
externalUserId
required
string <= 64 characters

Partner-side user id; must be bound to a platform member

required
Array of objects (OpenOrderItemReqVO) non-empty

Responses

Request samples

Content type
application/json
{
  • "externalUserId": "shopify_10086",
  • "items": [
    ]
}

PurchaseQueryAPI

Query a purchase order created by this partner. Pass either outOrderNo or orderNo.

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
outOrderNo
string <= 64 characters

Partner order no; pass this or orderNo

orderNo
string <= 64 characters

Platform order no; pass this or outOrderNo

Responses

Request samples

Content type
application/json
{
  • "outOrderNo": "string",
  • "orderNo": "string"
}

PurchaseCreateAPI

Create a purchase order. Idempotent on outOrderNo per partner. Returns paymentId for wallet pay. Optional expectedPayAmount is compared with live price; deviation beyond the threshold rejects the order.

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
outOrderNo
required
string <= 64 characters

Partner order no, unique per partner; used for idempotency

externalUserId
required
string <= 64 characters
required
Array of objects (OpenOrderItemReqVO) non-empty
addressId
integer <int64>

Member shipping address id; omit to use the member default address

orderComment
string <= 500 characters

Order remark

expectedPayAmount
integer <int32>

Payable from quote, CNY cents. If set, live price deviation beyond the threshold rejects the order.

Responses

Request samples

Content type
application/json
{
  • "outOrderNo": "SHOPIFY-20260811-0001",
  • "externalUserId": "shopify_10086",
  • "items": [
    ],
  • "addressId": 2048,
  • "orderComment": "string",
  • "expectedPayAmount": 24600
}

开放平台 / 商品订单

分页查询商品订单明细列表

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
pageNo
required
integer <int32> >= 1

页码,从 1 开始

pageSize
required
integer <int32> [ 1 .. 1000 ]

每页条数,最大值为 100

memberId
integer <int64>

会员ID(与 unionId 至少传一个)

unionId
string

会员编码(与 memberId 至少传一个)

status
integer <int32>

订单明细状态

orderNo
string

订单编号

orderItemNo
string

订单明细编号

createTime
Array of strings <date-time> [ items <date-time > ]

创建时间区间 [开始, 结束]

Responses

Request samples

Content type
application/json
{
  • "pageNo": 1,
  • "pageSize": 10,
  • "memberId": 1024,
  • "unionId": "M123456",
  • "status": 200,
  • "orderNo": "O20250624001",
  • "orderItemNo": "OG20250624001",
  • "createTime": [
    ]
}

开放平台 / 包裹发票

批量查询发票

只读取状态和成功文件的 URL,不触发生成或重试

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
orderNos
required
Array of strings [ 0 .. 50 ] items

下单返回的 orderNo,支持父单,最多50个

language
stringen|pt
Default: "en"

发票语言:en/pt,不传默认 en

Responses

Request samples

Content type
application/json
{
  • "orderNos": [
    ],
  • "language": "en"
}

批量异步生成发票

每个包裹及语言生成一次;失败或超时由调用方重新提交,无自动重试

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
orderNos
required
Array of strings [ 0 .. 50 ] items

下单返回的 orderNo,支持父单,最多50个

language
stringen|pt
Default: "en"

发票语言:en/pt,不传默认 en

Responses

Request samples

Content type
application/json
{
  • "orderNos": [
    ],
  • "language": "en"
}

开放平台 / 包裹单

根据包裹单号查询包裹信息

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
bagOrderNo
required
string

包裹单号

Responses

Request samples

Content type
application/json
{
  • "bagOrderNo": "BG20250624001"
}

分页查询包裹订单列表

Authorizations:
AuthorizationAuthorization
Request Body schema: application/json
required
pageNo
required
integer <int32> >= 1

页码,从 1 开始

pageSize
required
integer <int32> [ 1 .. 1000 ]

每页条数,最大值为 100

memberId
integer <int64>

会员ID(与 unionId 至少传一个)

unionId
string

会员编码(与 memberId 至少传一个)

status
integer <int32>

包裹状态

bagOrderNo
string

包裹单号

createTime
Array of strings <date-time> [ items <date-time > ]

创建时间区间 [开始, 结束]

Responses

Request samples

Content type
application/json
{
  • "pageNo": 1,
  • "pageSize": 10,
  • "memberId": 1024,
  • "unionId": "M123456",
  • "status": 6,
  • "bagOrderNo": "BG20250624001",
  • "createTime": [
    ]
}