Skip to main content

Transaction

Action prefix: order/… · Auth: Brand API authentication

order/new — Create a new transaction

KeyDescriptionRequiredType
order_numberYour unique order numberYesstring
pbtidPartnerBoost click track codeNostring
is_new_customerIs new customer in brandNobool
uidUser identity in brandNostring
currencyOrder currencyYesstring
trans_timeOrder trans timeYesstring
amountActual order amountNodouble
quantityQuantity of productsNoint
remarkAny messageNostring
couponcodeThe couponcode parameter receives a comma-delimited list of the coupon, promo, and/or discount codes used in the order.Nostring
skusSku list <required when your order has sku or else please input amount>Noarray

skus child fields

KeyDescriptionRequiredType
idProduct sku idYesstring
nameProduct nameNostring
amountacturl sku amountYesdouble
quantityQuantity of productsNoint
remarkAny messageNostring

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

KeyDescriptionRequiredType
order_numberYour unique order numberYesstring

Request:

{
"order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234"
}

Response:

{ "code": 0, "data": "", "msg": "success" }

order/effective — Effective transaction

KeyDescriptionRequiredType
order_numberYour unique order numberYesstring

Request:

{
"order_number": "RMD1a04ccbedbe2cde84d20cceb5f22c234"
}

Response:

{ "code": 0, "data": "", "msg": "success" }

order/bonus — Give bonus to publisher

KeyDescriptionRequiredType
medium_idPublisher identityYesstring
currencyOrder currencyYesstring
trans_timeOrder trans timeYesstring
commissionCommission for publisherYesdouble
remarkAny messageNostring

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.