Posthttps://seller-api.playerauctions.com/api/v1/offers/cancel
按指定条件取消部分或全部商品。
i. 请求示例
{
"offerIds": [1001, 1002],
"isAll": false,
"parameters": {
"keywords": "gold",
"listingStatus": "active",
"productType": "currency",
"gameId": 1,
"serverId": 10,
"factionId": 5
}
}ii. 请求参数
请求体参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
offerIds |
int[] | 否 | 待取消的商品编号。isAll 为 false 时必填。 |
isAll |
boolean | 是 | 是否取消符合筛选条件的所有商品。 设置为 true 时,无需提供 offerIds。 |
parameters |
object | 是 | 筛选参数,用于指定需要操作的商品。 |
└─ keywords
|
string | 是 | 按关键词筛选。 |
└─ listingStatus
|
string | 是 | 按商品状态筛选,例如: active(上架)、 hidden(隐藏)、 closed(已关闭)。 |
└─ productType
|
string | 是 | 按产品类别筛选,例如: all(全部)、 currency(货币)、 items(装备)、 accounts(账号)、 powerleveling(代练)、 topup(充值)。 |
└─ gameId
|
int? | 否 | 按游戏筛选。 |
└─ serverId
|
int? | 否 | 按服务器筛选。 |
└─ factionId
|
int? | 否 | 按阵营筛选。如果已提供 serverId,则忽略此参数。 |
iii. 响应示例
成功响应
{
"code": 10000,
"message": "Operation Successful.",
"requestId": "550e8400-e29b-41d4-a716-446655440000",
"data": {}
}错误响应
{
"code": 10002,
"message": "Invalid parameter.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}iv. 响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| code | int | 响应代码。10000 表示成功, 其它值为报错。 |
| message | string | 响应信息及报错详情。 |
| requestId | string | 请求标识号, 用以追溯。 |
注:
- 当
isAll设置为true,offerIds参数将被忽略,操作将应用于所有符合parameters中筛选条件的商品。 - 当
isAll设置为false,必须在offerIds数组内提供需要取消的商品编号。 - 当提供
parameters.serverId参数时,parameters.factionId参数将被忽略。