---
title: "order callback"
method: POST
path: "/yourApiAddress"
tags: ["Webhooks"]
---

# order callback

`POST /yourApiAddress`

## Request

- Base URL: `https://api.desty.app`
- URL: `https://api.desty.app/yourApiAddress`
- Auth: none declared. Required headers: `accessToken`

* 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

## Headers

- `accessToken` string, required

## Request body

- object
  - `orderId` string: orderId of omni
  - `orderSn` string: orderId of platform
  - `bookingSn` string: booking order id of booking order
  - `orderType` string: DEFAULT_ORDER、BOOKING_ORDER、MARKETPLACE_HANDLE_ORDER
  - `orderStatusList` string[]: order status of omni. lazada and tiktok will show in item
  - `subOrderStatusList` string[]: order sub status list
  - `platformOrderStatusList` string[]: platform order status list
  - `orderCreateTime` number: create time of order
  - `orderUpdateTime` number: update time of order
  - `createTime` number: order create time of omni
  - `hasPaid` boolean: whether order has paid
  - `orderPaymentTime` number
  - `includeTax` boolean
  - `buyerNotes` string
  - `subTotal` number: order total price
  - `discount` number: order discount
  - `tax` number: order tax
  - `totalPrice` number: finally order price
  - `insuranceCost` number
  - `paymentMethod` string
  - `platform` string: marketplace
  - `platformName` string
  - `preOrder` boolean
  - `codOrder` boolean: whether order is cash on delivery
  - `customerInfo` object
    - `name` string
    - `phone` string
    - `email` string
  - `platformOrderStatus` string: lazada and tiktok will show in item
  - `storeId` string: marketplace store id
  - `storeName` string: marketplace store name
  - `packageCount` integer
  - `totalWeight` number: the unit is g
  - `itemList` object[]: order item list
    - `itemOrderId` string
    - `itemId` string: omni sku id
    - `itemCode` string
    - `itemExternalCode` string
    - `itemName` string
    - `orderStatus` string
    - `platformOrderStatus` string
    - `description` string
    - `price` number
    - `quantity` number
    - `onHandStock` number
    - `promotionStock` number
    - `discountAmount` number
    - `taxAmount` number
    - `sellPrice` number
    - `originalPrice` number
    - `locationName` string: name of warehouse
    - `locationId` string: id of warehouse
    - `platformWarehouseId` string
    - `platformWarehouseName` string
    - `platformWarehouseAddress` string
    - `imageUrl` string
    - `shippingDetail` object
      - `shippingCost` number
      - `shippingFullName` string
      - `shippingAddress` string
      - `shippingArea` string
      - `shippingCity` string
      - `shippingProvince` string
      - `shippingPostCode` string
      - `shippingPhone` string
      - `deliveryDeadline` string
      - `trackingNumber` string
      - `courier` string
      - `shipper` string
      - `portCode` string
      - `regionCode` string
      - `returnPortCode` string
      - `isShipped` boolean
  - `orderEditDetails` object[]
    - `editTimes` integer
    - `itemList` object[]
      - `editItemId` string
      - `itemCode` string
      - `itemExternalCode` string
      - `itemName` string
      - `imageUrl` string
      - `price` number
      - `quantity` number
      - `locationName` string
      - `locationId` string
      - `platformWarehouseId` string
      - `platformWarehouseName` string
      - `platformWarehouseAddress` string
  - `cancelBy` string
  - `logisticStatus` string
  - `cancelReason` string
  - `packageOrganizeType` string: Single / Splitted / Combined
  - `sellerDiscount` number
  - `otherCost` number
  - `isStockReturned` boolean
  - `shopifyThirdParty` boolean
  - `tiktokNDD` boolean
  - `orderEditTimes` integer

## Response `200`

successful operation

- object

---

[API](https://skmtc.dev/desty/apis/desty-omni-openapi-2026-6-26.md) - [All operations](https://skmtc.dev/desty/apis/desty-omni-openapi-2026-6-26/llms.txt) - [OpenAPI document](https://skmtc.dev/desty/apis/desty-omni-openapi-2026-6-26/revisions/4946760fb77d?raw)