This page contains the detailed payload of an order.
Prerequisites
It’s better to know about our current operation models and guiding before stepping into the order details.
- Understand about operation models
- Followed the order guide
Payload detail
Order detail
| Name | Type | Example | Description |
|---|---|---|---|
| code | String | 745467462 | Unique order code |
| relation_code | String | 896493516 | The order code of the parent order The parent order is splited or modified into this (and others) order |
| fulfillment_type | String | cross_border | How the order is fulfilled a.k.a the fulfillment model of the order See order fulfillment type |
| status | String | complete | The status where the order is in the process to customer hands |
| is_rma | Boolean | false | Is this order a replacement for a returned product or a servicing product (RMA flow) |
| is_vat_exporting | Boolean | false | If the customer requested to export VAT bill |
| has_backorder_items | Boolean | true | If this order has at least 1 Order Item V2 with inventory_type=backorder |
| created_at | Timestamp | 2020-08-10 18:50:17 | When the order is created |
| updated_at | Timestamp | 2020-08-18 11:10:02 | The latest update time of the order |
| invoice | Order Invoice | The order invoice data: Total value, discounts, fees of customer and seller | |
| tiki_warehouse | Tiki Warehouse Info | The Tiki warehouse that fulfills the order | |
| items | List<Order Item V2> | All Order Item V2s details | |
| shipping | Shipping Info | Shipping information of the order: Shipping status, plan, partner, address | |
| payment | Payment Info | Payment information | |
| delivery | Delivery Confirmation | Delivery confirmation | |
| customer | Customer Info | Customer information | |
| installment_info | Installment Info | Installment information | |
| cancel_info | Cancel Info | Cancellation details | |
| rma_info | Rma Info | RMA information | |
| status_histories | List<Status History> | All the status changes of this order | |
| seller_warehouse | Seller Warehouse | Seller warehouse info to pickup order | |
| store | Seller Store Info | Seller store info |
Order V2 Sample
{
"code": "950030154",
"relation_code": "",
"fulfillment_type": "cross_border",
"status": "complete",
"is_rma": false,
"is_vat_exporting": false,
"has_backorder_items": true,
"created_at": "2020-08-13 22:53:18",
"updated_at": "2020-08-15 11:10:02",
"invoice": {
"items_count": 1,
"items_quantity": 1,
"subtotal": 455000,
"grand_total": 0,
"collectible_amount": 0,
"discount_amount": 474000,
"discount_tikixu": 474000,
"discount_promotion": 0,
"discount_percent": 0,
"discount_coupon": 0,
"discount_other": 0,
"gift_card_amount": 0,
"gift_card_code": null,
"coupon_code": null,
"shipping_amount_after_discount": 19000,
"shipping_discount_amount": 0,
"handling_fee": 0,
"other_fee": 0,
"total_seller_fee": -69434.34,
"total_seller_income": 385565.66,
"purchased_at": "2020-08-13 22:53:18",
"tax_info": null
},
"tiki_warehouse": {
"id": 4,
"name": "Sài Gòn",
"code": "sgn"
},
"items": [
{
"id": 156907849,
"product": {
"id": 11464923,
"type": "simple",
"super_id": 0,
"master_id": 11464922,
"sku": "8609380684187",
"name": "Easy Learning Complete German Grammar, Verbs & Vocabu",
"catalog_group_name": null,
"inventory_type": "backorder",
"imeis": [],
"serial_numbers": [],
"thumbnail": "https://salt.tikicdn.com/cache/280x280/ts/product/9d/df/0e/20272d014757fb8d94eabb8a630b088b.jpg",
"seller_product_code": "9780008141783",
"seller_supply_method": null
},
"invoice": {
"price": 455000,
"quantity": 1,
"subtotal": 455000,
"row_total": 0,
"discount_amount": 474000,
"discount_tikixu": 474000,
"discount_promotion": 0,
"discount_percent": 0,
"discount_coupon": 0,
"discount_other": 0,
"discount_tikier": 0,
"discount_tiki_first": 0,
"is_seller_discount_coupon": false,
"is_taxable": false,
"fob_price": 0,
"seller_fee": -69434.34,
"seller_income": 385565.66,
"fees": [
{
"id": 205244033,
"fee_type_key": "percent_per_item_sales_value",
"fee_type_name": "Chiết khấu",
"status": 1,
"quantity": 1,
"base_amount": 8,
"total_amount": -36400,
"discount_amount": 0,
"final_amount": -36400
},
{
"id": 205244034,
"fee_type_key": "payment_processing_fee",
"fee_type_name": "Phí thanh toán",
"status": 1,
"quantity": 1,
"base_amount": 2,
"total_amount": -9100,
"discount_amount": 0,
"final_amount": -9100
},
{
"id": 205244037,
"fee_type_key": "ict_tax_fee",
"fee_type_name": "Phí nhà thầu",
"status": 1,
"quantity": 1,
"base_amount": 3934.34,
"total_amount": -3934.34,
"discount_amount": 0,
"final_amount": -3934.34
},
{
"id": 205244035,
"fee_type_key": null,
"fee_type_name": null,
"status": 1,
"quantity": 1,
"base_amount": 20000,
"total_amount": -20000,
"discount_amount": 0,
"final_amount": -20000
}
]
},
"seller": {
"id": 14626,
"name": "Experal"
},
"confirmation": {
"status": "confirmed",
"confirmed_at": "2020-08-14 08:42:33",
"available_confirm_sla": "2020-08-14 12:00:00",
"pickup_confirm_sla": null,
"histories": [
{
"confirmed_at": "2020-08-14 08:42:33.0",
"order_item_id": 156907849,
"sla_confirmed_at": "2020-08-14 12:00:00.0",
"status": "confirmed"
},
{
"confirmed_at": "2020-08-14 08:42:33.0",
"order_item_id": 156907849,
"sla_confirmed_at": "2020-08-14 12:00:00.0",
"status": "seller_confirmed"
},
{
"confirmed_at": null,
"order_item_id": 156907849,
"sla_confirmed_at": "2020-08-14 12:00:00.0",
"status": "waiting"
}
]
},
"inventory_requisition": {
"id": 15030509,
"code": "SGN/BOP/20/08/350345",
"seller_inventory_id": 13175,
"status": "done",
"is_printed": false,
"pickup_method": "cross_border",
"warehouse_code": "sgn",
"error": null,
"created_at": "2020-08-14 08:42:33"
},
"inventory_withdrawals": []
}
],
"shipping": {
"partner_id": "1",
"partner_name": "Tiki Team",
"tracking_code": null,
"status": "New",
"plan": {
"id": 1,
"name": "Giao hàng tiêu chuẩn",
"is_free_shipping": false,
"promised_delivery_date": "2020-08-28 23:59:59",
"description": "Giao vào Thứ sáu, 28/08"
},
"address": {
"full_name": "Ho Tan Hung",
"street": "C/c 86 Tản Đà, phòng 0711",
"ward": "Phường 11",
"ward_tiki_code": "VN039013011",
"district": "Quận 5",
"district_tiki_code": "VN039013",
"region": "Hồ Chí Minh",
"region_tiki_code": "VN039",
"country": "Việt Nam",
"country_id": "VN",
"email": null,
"phone": "0908******"
}
},
"payment": {
"method": "cod",
"is_prepaid": false,
"status": "success",
"description": "Thanh toán tiền mặt khi nhận hàng"
},
"delivery": {
"delivery_confirmed": false,
"delivery_confirmed_at": null,
"delivery_confirmed_by_customer": false,
"delivery_confirmed_by_customer_at": null,
"delivery_note": null
},
"customer": {
"id": 1921399,
"full_name": "Tan Hung Ho"
},
"installment_info": null,
"cancel_info": null,
"rma_info": null,
"status_histories": [
{
"id": 1109657602,
"status": "processing",
"created_at": "2020-08-13 22:53:18"
},
{
"id": 1109657630,
"status": "cho_in",
"created_at": "2020-08-13 22:53:20"
},
{
"id": 1110718708,
"status": "cho_in",
"created_at": "2020-08-14 19:11:03"
},
...
{
"id": 1111334909,
"status": "giao_hang_thanh_cong",
"created_at": "2020-08-15 11:07:53"
},
{
"id": 1111334910,
"status": "giao_hang_thanh_cong",
"created_at": "2020-08-15 09:53:00"
},
{
"id": 1111336387,
"status": "complete",
"created_at": "2020-08-15 11:07:53"
}
],
"seller_warehouse": {
"id": 3302,
"name": "Kho tính distance 2",
"code": "WH000003302",
"street": "496-496A-496B Nguyễn Thị Minh Khai",
"region_code": "VN039",
"region_id": 294,
"region_name": "Hồ Chí Minh",
"district_code": "VN039011",
"district_id": 486,
"district_name": "Quận 3",
"ward_code": "VN039011002",
"ward_id": 10443,
"ward_name": "Phường 02",
"country_code": "vn",
"longitude": 106.68235,
"latitude": 10.76634
},
"store": {
"id": 1452,
"name": "Farmers Market - Store 1",
"url": "farmers-market-store-1-i1452"
}
}Order Fulfillment Type
| Fulfillment Type | Description |
|---|---|
| tiki_delivery | Supplied by either Tiki or Seller Delivered by Tiki |
| seller_delivery | Supplied by Seller Delivered by Seller |
| cross_border | Supplied oversea by Seller |
| dropship | Supplied by Seller Delivered by Tiki directly to Customer |
| instant_delivery | Supplied by either Tiki or Seller Delivered instantly online: Ebooks, eVoucher, scratch cards… |
Order Invoice
This object contains total value, discounts and fees of customer and seller.
| Name | Type | Example | Description |
|---|---|---|---|
| items_count | Integer | 1 | Number of Order Item V2s |
| items_quantity | Integer | 1 | Total quantity of products over all Order Item V2s |
| subtotal | Decimal | 409000.00 | Total value of products over all Order Item V2s |
| grand_total | Decimal | 0.00 | Total value of the order the customer needs to pay (counted all customer discounts and customer fees) |
| collectible_amount | Decimal | 0.00 | For Cash on Delivery: Total value to collect from the customer when deliver |
| discount_amount | Decimal | 428000.00 | Total discount value on the order for the customer |
| discount_tikixu | Decimal | 428000.00 | Discount value due to the use of Tiki Xu |
| discount_promotion | Decimal | 0.00 | Discount due to promotion at the time of purchasing |
| discount_percent | Decimal | 0.00 | Discount due by percent of order value |
| discount_coupon | Decimal | 0.00 | Discount value due to the use of coupons |
| discount_other | Decimal | 0.00 | Discount value due to other reasons (if any) |
| gift_card_amount | Decimal | 0.00 | Discount value due to the use gift cards |
| gift_card_code | String | The gift card code entered by the customer when purchases the order | |
| coupon_code | String | The coupon code entered by the customer when purchases the order | |
| shipping_amount_after_discount | Decimal | 19000.00 | The shipping fee after discount the customer needs to pay |
| shipping_discount_amount | Decimal | 0.00 | The discount of the shipping fee |
| handling_fee | Decimal | 0.00 | The handling fee for oversized products the customer needs to pay |
| other_fee | Decimal | 0.00 | Other customer fee |
| total_seller_fee | Decimal | 0.00 | The final fee amount in seller statement |
| total_seller_income | Decimal | 409000.00 | The final income amount in seller statement |
| purchased_at | Timestamp | 2020-08-10 18:50:17 | When the payment is made |
| tax_info | Tax Info | Customer tax information |
How to compute these numbers?
discount_amountis the final discount a customer is benefited on the order:discount_amount= all discount (includediscount_tikixuanddiscount_promotion)discount_promotion= all promotion (includediscount_percent,discount_coupon,discount_other,…)
subtotalis the total value of all product items:subtotal= ∑ (OrderItemInvoice.quantity*OrderItemInvoice.price)
grand_totalis final amount a customer has to pay for this order after all discounts and fees:grand_total=subtotal–discount_amount–gift_card_amount+shipping_amount_after_discount+handling_fee+other_fee- If computed
grand_totalis< 0, then it will be set tozero(0)
total_seller_incomeis the final amount the seller will receive after all fees and fee discounts:total_seller_income= ∑ (OrderItemInvoice.seller_income)total_seller_fee= ∑ (OrderItemInvoice.seller_fee)
How to compute discounts?
Formula for computing discounts on the order is complex and changes frequently according to our
business logic. Because discount_amount already counted all kinds of discounts, we can simply use this
field to compute grand_total and total_seller_income.
What do minus (-) and plus (+) mean in invoice?
- All things related to seller account like
total_seller_fee,total_seller_income,seller_fee,seller_income… are treated as statement entry in seller account:150000means income, return or revenue-25000means expense, charge or cost
total_seller_feeis later counted intotal_seller_income- Examples for seller fee:
total_seller_fee = -30000: The seller is charged for30000due to operation feestotal_seller_fee = 50000: The seller receives50000due to operation feestotal_seller_income = 150000: The final amount seller will receive from Tiki is150000total_seller_income = -50000: The final amount seller is … charged on the order is50000
But how can the seller fee be a positive amount?
This is due to the shipping_fee_customer: The shipping fee the seller charges on the customer.
But how can the seller get charged on the order?
This is due to the seller operation fees on the order is bigger than total product value:
- Seller sets the price too low or
- Seller violates the SLAs
- …
Tiki Warehouse Info
The Tiki warehouse that fulfills the order. This Tiki warehouse information
together with appropriate seller inventories must be used to confirm the order.
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 17 | Warehouse unique id |
| name | String | Ha Noi 4 | Warehouse friendly name |
| code | String | hn4 | Warehouse unique code |
Shipping Info
| Name | Type | Example | Description |
|---|---|---|---|
| partner_id | String | 2 | Selected shipping partner unique Id |
| partner_name | String | GHN | Selected shipping partner name |
| tracking_code | String | 31416789187639 | Tracking number for the shipment |
| status | String | Delivered | Shipping status |
| plan | Shipping Plan | Shipping plan details | |
| address | Shipping Address | Shipping address details |
Shipping Plan
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 1 | The plan unique Id |
| name | String | Giao hàng tiêu chuẩn | The plan name |
| is_free_shipping | Boolean | false | Is the shipping free |
| promised_delivery_date | Timestamp | 2020-08-24 23:59:59 | The delivery deadline |
| description | String | Giao vào Thứ hai, 24/08 | A short Vietnamese description about the delivery deadline |
Shipping plan description
| Shipping Plan Id | Shipping Plan Name |
| 1 | Standard plan |
| 3 | Tiki Now plan |
| 6 | Scheduled plan |
Shipping Address
The details shipping address. The shipping address has 2 private information `email` and `phone`, these fields are only available
in orders with fulfillment_type of seller_delivery or cross_border.
| Name | Type | Example | Description |
|---|---|---|---|
| full_name | String | NGUYỄN THỊ Z | Recipient full name |
| street | String | 13 Nguyen Duc Canh | Address details |
| ward | String | Đình Xuyên | Ward name |
| ward_tiki_code | String | VN034005007 | Unique ward code |
| district | String | Gia Lâm | District name |
| district_tiki_code | String | VN034005 | Unique district code |
| region | String | Hà Nội | Region or city name |
| region_tiki_code | String | VN034 | Unique region or city code |
| country | String | Việt Nam | Country name |
| country_id | String | VN | Unique country code |
| String | example@mail.com | Recipient email | |
| phone | String | 0123111111 | Recipient phone number |
Payment Info
| Name | Type | Example | Description |
|---|---|---|---|
| method | String | cod | Payment method Values: cod, checkmo, momo, pay123, cybersource |
| is_prepaid | Boolean | false | The order is prepaid |
| status | String | success | Status of the payment |
| description | String | Thanh toán tiền mặt khi nhận hàng | Description of the payment method |
Delivery Confirmation
| Name | Type | Example | Description |
|---|---|---|---|
| delivery_confirmed | Boolean | true | Delivery has been confirmed by Tiki, shipping partner or seller |
| delivery_confirmed_at | Timestamp | 2020-08-10 15:37:32 | When delivery has been confirmed |
| delivery_confirmed_by_customer | Boolean | false | Delivery has been confirmed by customer |
| delivery_confirmed_by_customer_at | Timestamp | When the delivery has been confirmed by customer | |
| delivery_note | String | Order TKB.RRSIIRQ3 BookingID 4283 has been delivered | Delivery note |
Customer Info
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 969444 | Customer Id |
| full_name | String | Trương Bình T | Customer full name |
Installment Info
Installment Info Sample
{
"installment_fee": 0,
"month": 6,
"monthly_pay": 811667
}| Name | Type | Example | Description |
|---|---|---|---|
| installment_fee | Decimal | 240000.00 | Installment fee of the order |
| month | Integer | 12 | Installment payment term in number of months |
| monthly_pay | Decimal | 390833.00 | The monthly pay during the payment term |
Cancel Info
Below is a cancel info sample.
{
"reason_code": "202",
"reason_text": "Đặt trùng:dat trung",
"comment": null,
"created_at": "2020-08-24 16:52:37"
}| Name | Type | Example | Description |
|---|---|---|---|
| reason_code | String | 2034 | Unique cancel reason code. |
| reason_text | String | Thời gian giao hàng quá lâu/sớm | Cancel reason short description. This may include customer’s explanation. |
| comment | String | Cancel reason details description | |
| canceled_at | Timestamp | 2020-06-16 23:59:43 | When the order is canceled |
You can see a list of all reason codes here.
RMA Info
RMA Info Sample
{
"id": 651612,
"warehouse_id": 20,
"original_order_code": "335173848",
"exchanged_order_code": "953499398",
"status": "Đổi sản phẩm mới",
"created_at": "2020-08-18"
}RMA stands for Return Merchandise Authorization – is a part of the process of
returning a product to receive a refund, replacement, or repair during the product’s warranty period.
Both parties can decide how to deal with it, which could be refund, replacement or repair.
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 603055 | Unique Id of the RMA process |
| warehouse_id | Integer | 16 | The Tiki warehouse which handles this process |
| original_order_code | String | 789783969 | The original order of which the product is returned or serviced Code of the other order |
| exchanged_order_code | String | 745467462 | The replacement order for the original order/product Code of this order |
| status | String | Hoàn thành | Status of the RMA process |
| created_at | Timestamp | 2020-06-09 | When the RMA process is started |
Tax Info
Tax Info Sample
{
"code": "3901******",
"address": "Lô ****, Ấp Thuận Đông, Xã Lợi Thuận, Huyện Bến Cầu, Tây Ninh ",
"company_name": "CÔNG TY TNHH MỘT THÀNH VIÊN ******* VIỆT NAM "
}Customer tax information
| Name | Type | Example | Description |
|---|---|---|---|
| code | String | 370281**** | Tax code |
| address | String | Số 30 Hoàng Hoa Thám... | Tax address |
| company_name | String | CONG TY TNHH ABC MEDIA | Tax company |
Status History
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 1105187480 | Unique Id of the history entry |
| status | String | successful_delivery | Order status |
| created_at | Timestamp | 2020-08-10 18:50:17 | When the order arrives at this status |
Seller Warehouse
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 1105187480 | Unique Id of the warehouse |
| name | String | Kho hang tong | Name of the warehouse |
| code | String | WH000003302 | Unique code of the warehouse |
| street | String | Số 30 Hoàng Hoa Thám... | Address details |
| region_code | String | VN039 | Unique region code |
| region_id | Integer | 295 | Unique region id |
| region_name | String | Hồ Chí Minh | Region name |
| district_code | String | VN039007 | Unique district code |
| district_id | Integer | 200 | Unique district id |
| district_name | String | Quận 10 | District name |
| ward_code | String | VN039007004 | Unique ward code |
| ward_id | Integer | 10443 | Unique ward tiki |
| ward_name | String | Phường 4 | Ward name |
| longitude | Float | 106.68235 | Longitude of the warehouse |
| latitude | Float | 10.76634 | Latitude of the warehouse |
Store Info
| Name | Type | Example | Description |
|---|---|---|---|
| id | Integer | 1105187480 | Unique Id of the store |
| name | String | BigC Thủ Dầu Một | Name of seller store |
| url | String | bigc-thu-dau-mot-store-1-i1452 | Tiki url of the seller store |