Transaction
Action prefix: order/… · Auth: Brand API authentication
order/new — Create a new transaction
| Key | Description | Required | Type |
|---|---|---|---|
order_number | Your unique order number | Yes | string |
pbtid | PartnerBoost click track code | No | string |
is_new_customer | Is new customer in brand | No | bool |
uid | User identity in brand | No | string |
currency | Order currency | Yes | string |
trans_time | Order trans time | Yes | string |
amount | Actual order amount | No | double |
quantity | Quantity of products | No | int |
remark | Any message | No | string |
couponcode | The couponcode parameter receives a comma-delimited list of the coupon, promo, and/or discount codes used in the order. | No | string |
skus | Sku list <required when your order has sku or else please input amount> | No | array |
skus child fields
| Key | Description | Required | Type |
|---|---|---|---|
id | Product sku id | Yes | string |
name | Product name | No | string |
amount | acturl sku amount | Yes | double |
quantity | Quantity of products | No | int |
remark | Any message | No | string |
Request:
{
"order_number": "RMD17ea9a09be7c4bd4101aa3d21df80b47",
"currency": "USD",
"trans_time": "Thu, 20 Jan 2022 05:27:30 GMT",
"pbtid": "ldc_xdw3",
"amount": 111.55,
"skus": [
{
"id": "B07K1WWBJK",
"name": "Apple Pencil (2nd Generation)",
"amount": 11.15,
"quantity": 1
}
]
}
Response:
{
"code": 0,
"data": "210120052732256X22",
"msg": "success"
}
order/void — Void transaction
| Key | Description | Required | Type |
|---|---|---|---|
order_number | Your unique order number | Yes | string |
Request:
{
"order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234"
}
Response:
{ "code": 0, "data": "", "msg": "success" }
order/effective — Effective transaction
| Key | Description | Required | Type |
|---|---|---|---|
order_number | Your unique order number | Yes | string |
Request:
{
"order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234"
}
Response:
{ "code": 0, "data": "", "msg": "success" }
order/bonus — Give bonus to publisher
| Key | Description | Required | Type |
|---|---|---|---|
medium_id | Publisher identity | Yes | string |
currency | Order currency | Yes | string |
trans_time | Order trans time | Yes | string |
commission | Commission for publisher | Yes | double |
remark | Any message | No | string |
Request:
{
"medium_id": "LDC0012346",
"currency": "USD",
"trans_time": "Thu, 20 Jan 2022 05:27:30 GMT",
"commission": 416.4,
"remark": "Performance bonus"
}
Response:
{
"code": 0,
"data": "210120052732256X22",
"msg": "success"
}
Lifecycle
order/new → order/effective (confirm) or order/void (cancel)
order/bonus (discretionary payout, independent path)
Idempotency
Use stable order_number values. Duplicate posts may return errors depending on order state.