Webhooks

order callback

  • when order status change, this webhooks will notify you
  • you should return http status 200 if done success

we will add accessToken at header, the accessToken is you get from   "/api/auth/token" ,

  • only if you apply the authority of tenant, we will notify you when order status change
  • you can use accessToken to differentiate omni users.
  • you can use accessToken to verify whether the request is from omni;
  • When you reapply for authorization, we will use the new token to put in the request header,But due to concurrency issues, you need to be compatible with old tokens.Recommended is 1 hour
post/yourApiAddress

Request

  • Base URL
    https://api.desty.app
  • Auth
    none declared. Required headers: accessToken

Headers

accessTokenstring required

accessToken (Only:undefined)

Request body

orderIdstring

orderId of omni

orderSnstring

orderId of platform

bookingSnstring

booking order id of booking order

orderTypestring

DEFAULT_ORDER、BOOKING_ORDER、MARKETPLACE_HANDLE_ORDER

orderStatusListstring[]

order status of omni. lazada and tiktok will show in item

subOrderStatusListstring[]

order sub status list

platformOrderStatusListstring[]

platform order status list

orderCreateTimenumber

create time of order

orderUpdateTimenumber

update time of order

createTimenumber

order create time of omni

hasPaidboolean

whether order has paid

orderPaymentTimenumber
includeTaxboolean
buyerNotesstring
subTotalnumber

order total price

discountnumber

order discount

taxnumber

order tax

totalPricenumber

finally order price

insuranceCostnumber
paymentMethodstring
platformstring

marketplace

platformNamestring
preOrderboolean
codOrderboolean

whether order is cash on delivery

platformOrderStatusstring

lazada and tiktok will show in item

storeIdstring

marketplace store id

storeNamestring

marketplace store name

packageCountinteger
totalWeightnumber

the unit is g

cancelBystring
logisticStatusstring
cancelReasonstring
packageOrganizeTypestring

Single / Splitted / Combined

sellerDiscountnumber
otherCostnumber
isStockReturnedboolean
shopifyThirdPartyboolean
tiktokNDDboolean
orderEditTimesinteger

Response

successful operation

object required

Changes

No recorded changes to this operation across all 3 revisions of this API.