The table below lists APIs that can be used for orders management.

Order APIs require order scope.

All operation models

Drop-shipping

On-demand fulfillment

Seller delivery

Cross border

Order Listing V2

Returns a list of sales orders managed by the authorized seller, base on a specific search query.

What’s new?

• Re-organized payload:
  • Group related properties into objects
  • Rename confused fields
• Correct invoice information when querying by seller
• Split order information into includeable options

HTTP Request

GET https://api.tiki.vn/integration/v2/orders?code=303886378,781534461

Query parameters

All query parameters are optional.

Set Expression

• Format: operator%7Ccomma,separated,values. Where %7C stands for character “|“
• Supported set operators:
  • in: The property carries a value belong to the values set
  • nin: The property carries a value NOT belong to the values set
• Examples:
  • fulfillment_type=in|cross_border,dropship: Search orders that have the fulfillment type of cross_border OR dropship
  • status=nin|complete,successful_delivery: Search orders that are NOT completed and NOT delivered yet

Timestamp

• Format: yyyy-MM-dd HH:mm:ss
• The timestamp will be undertood as it is at UTC+07:00
• Example: 2020-08-20 15:00:00 will be understood as 2020-08-20T15:00:00+0700

Include-able

Response Ok

If everything is ok, you will receive a list of orders according to what you requested:

Response Exception

If something wrong happens, you will receive the error body with explanations.

Order Details V2

HTTP Request

GET https://api.tiki.vn/integration/v2/orders/303886378?include=status_histories

Query parameters

All query parameters are optional.

Response Ok

The Order object if found.

Response Exception

If something wrong happens, you will receive the error body with explanations. This object describes many common errors.
Additional 4xx error includes:

• 400 Order not found

Confirm enough stock

This API support confirm available stock for operation models:

• On-Demand Fulfillment
• Seller Delivery
• Cross Border

Only confirm the order when:

• Has status = queueing
• Has at least 1 item with items/*/product/inventory_type = backorder && items/*/confirmation/status = waiting

HTTP Request

POST https://api.tiki.vn/integration/v2/orders/4244037251/confirm-available

Here orderCode denotes the order you want to confirm.

Request Body

{
    "available_item_ids": [
        1334323
    ],
    "seller_inventory_id": 1089
}

For example, your order has 3 items

• 111111111 (SKU=739348298529354)
• 22222222 (SKU=134534448529354)
• 3333333 (SKU=828348298529354).

But you see that your warehouse does not have enough SKU=139348298529354 (the 2nd item). You should confirm you have enough other items: [111111111, 3333333], these items will be seller_confirmed. And in this case, 2nd item 22222222 will be seller_canceled.

Response Ok

{
    "code": 200,
    "data": [
        {
            "id": 109481415,
            "message": null
        }
    ]
}

Response Exception

If something wrong happens, you will receive the error body with explanations. This object describes many common errors.

Get expected pickup times

Deprecating.

From July 10th, 2023, we deprecate this API because of changing in order confirmation requirement:
– Tiki will decide pickup time for all drop-shipping orders
– Seller will only need to confirm product availability for these orders

After July 10th, 2023, this API will enter compatibility mode: Return exactly one pickup slot, so system using this API can still use this API without issue.

This API returns the expected pickup times a seller can use to confirm their drop-shipping order.

HTTP Request

GET https://api.tiki.vn/integration/v2/orders/dropship/expected-pickup-slots

Response Ok

{
    "seller_id": 875,
    "pickup_slots": [
        {
            "expected_pickup_slot": "sameday_1pm",
            "expected_pickup_time": "2021-11-29 13:00:00"
        }
    ]
}

Response Exception

If something wrong happens, you will receive the error body with explanations.

Confirm enough stock for Drop Shipping

This API support confirm available stock for Drop Shipping operation model. After seller has confirmed enough stock, seller has to pack products properly. And prepare to for the driver to come picking the package.

Only confirm the dropship order when:

• Has status = queueing
• Has at least 1 item with items/*/product/inventory_type = backorder && items/*/confirmation/status = waiting

Change from July 10th, 2023

From July 10th, 2023, we change order confirmation requirement:
– Tiki will decide pickup time for all drop-shipping orders:
– Seller will only need to confirm product availability for these orders
– expected_pickup_time is deprecated

HTTP Request

POST https://api.tiki.vn/integration/v2/orders/4244037251/dropship/confirm-available

Here orderCode denotes the order you want to confirm availability.

Request Body

{
    "confirmation_status": "seller_confirmed",
    "seller_inventory_id": 938
}

Response Ok

{
    "code": 200
}

Response Exception

If something wrong happens, you will receive the error body with explanations.

Confirm packing is done for Drop Shipping

Deprecated.

This operation is not necessary anymore. You only need to provide your expected pickup time in the confirm enough drop-ship stock API.

This API support confirm done packing for Drop Shipping operation model. After seller has confirmed packing, Tiki goes picking up the package and delivers it to customer directly – not through Tiki warehouses.

Only confirm packing the dropship order when:

• Has status = queueing
• Has at least 1 item with items/*/product/inventory_type = backorder && items/*/confirmation/status = seller_confirmed

HTTP Request

POST https://api.tiki.vn/integration/v2/orders/4244037251/dropship/confirm-packing

Here orderCode denotes the order you want to confirm packing.

Request Body

{
    "seller_inventory_id": 938
}

Response Ok

{
    "code": 200
}

Response Exception

If something wrong happens, you will receive the error body with explanations.

Get seller inventories for confirmation

This API return seller inventories and mappings from Tiki warehouses to seller inventories – which
will be used in order confirmation and dropship confirmation.

Notes, this API only return active & requisition inventories those matches the Tiki warehouse codes.

HTTP Request

GET https://api.tiki.vn/integration/v2/seller-inventories?tiki_warehouse_codes=sgn,sgn3,hn4

Query parameters

Response OK

{
    "seller_inventories": [
        {
            "id": 558,
            "seller_id": 871,
            "is_primary": false,
            "name": "Seller Alice Shop Hà Nội",
            "status": 1,
            "address": {
                "street": "01 đường số 2",
                "ward": "Xã Đông Xuân",
                "district": "Huyện Sóc Sơn",
                "region": "Hà Nội",
                "country": "Viet Nam"
            },
            "type": "requisition"
        },
        {
            "id": 1227,
            "seller_id": 871,
            "is_primary": false,
            "name": "HCM",
            "status": 1,
            "address": {
                "street": "Test",
                "ward": "Phường 04",
                "district": "Quận 6",
                "region": "Hồ Chí Minh",
                "country": "Viet Nam"
            },
            "type": "requisition"
        }
    ],
    "mappings": [
        {
            "tiki_warehouse_code": "sgn",
            "seller_inventory_ids": [
                1227
            ]
        },
        {
            "tiki_warehouse_code": "sgn3",
            "seller_inventory_ids": [
                1227
            ]
        },
        {
            "tiki_warehouse_code": "hn4",
            "seller_inventory_ids": [
                558
            ]
        }
    ]
}

For example, below mapping means if the order has Tiki warehouse of hn4, seller must choose either seller inventory 558 or 693 to confirm the order.

{
    "tiki_warehouse_code": "hn4",
    "seller_inventory_ids": [
        558,
        693
    ]
}

Response Exception

If something wrong happens, you will receive the error body with explanations. This object describes many common errors.

Update delivery status for seller delivery

When you deliver the a seller delivery order, you need to tell whether the delivery is successful or not.

HTTP Request

POST https://api.tiki.vn/integration/v2/orders/{code}/seller-delivery/update-delivery

Request body

Content-Type: application/json

Possible failure_cause:

Example request body:

{
    "status": "failed_delivery",
    "failure_cause": "out_of_needs",
    "note": "Cannot contact customer"
}

Response ok

Content-Type: application/json

Response exception

If something wrong happens, you will receive the error body with explanations.

Update shipment status for cross border

Only call this endpoint to update the shipment status of your cross border orders if you have one of the following conditions:

• You are 3rd Party Logistic partner
• Your store handles the shipment of the oversea packages to customers – self-deliver mode

HTTP Request

POST https://api.tiki.vn/integration/v2/orders/{code}/cross-border/update-shipment

Request body

Content-Type: application/json

Shipment status options for self-deliver cross_border:

Finally, your order delivery status becomes successful delivery, everything is settled.

Example request body:

{
    "status": "customs_clearance",
    "update_time": "2021-06-11 12:00:00"
}

Response ok

Content-Type: application/json

Response exception

If something wrong happens, you will receive the error body with explanations.

Get shipping label for on-demand fulfillment

Return order label of an order, with a selectable format. Only invoke this endpoint when:

• Order operation model is on-demand fulfillment
• Order is already confirmed to have enough stock
• Order status != canceled

HTTP Request

GET https://api.tiki.vn/integration/v2/orders/{code}/tiki-delivery/labels?format=

Query parameters

Response ok

Example response body:

{
    "shipping_label_url": "https://uat.tikicdn.com/ts/print/c68cf4ba4b.html"
}

Response exception

If something wrong happens, you will receive the error body with explanations.

Get invoice label for seller delivery

Return invoice label of a seller delivery order, with a selectable format. Only invoke this endpoint when:

• Order operation model is seller delivery
• Order is already confirmed to have enough stock
• Order status != canceled

HTTP Request

GET https://api.tiki.vn/integration/v2/orders/{code}/seller-delivery/labels?format=

Query parameters

Response ok

Example response body:

{
    "invoice_label_url": "https://uat.tikicdn.com/ts/print/c68cf4ba4b.html"
}

Response exception

If something wrong happens, you will receive the error body with explanations.

Get shipping stamp for dropship

Return order labels of a drop shipping order, with a selectable format. Only invoke this endpoint when:

• Order operation model is drop shipping
• Order is already confirmed to have enough stock
• Order status != canceled

HTTP Request

GET https://api.tiki.vn/integration/v2/orders/{code}/dropship/labels?format=

Query parameters

Response ok

Example response body:

{
    "shipping_label_url": "https://uat.tikicdn.com/ts/print/c68cf4ba4b.html",
    "shipping_stamp_url": "https://uat.tikicdn.com/ts/print/a7s5baa1a2.html",
}

Response exception

If something wrong happens, you will receive the error body with explanations.

Get cross border label for cross border

Return order label of a cross border order, with a selectable format. Only invoke this endpoint when:

• Order operation model is cross border
• Order is already confirmed to have enough stock
• Order status != canceled

HTTP Request

GET https://api.tiki.vn/integration/v2/orders/{code}/cross-border/labels?format=

Query parameters

Response ok

Example response body:

{
    "crossborder_label_url": "https://uat.tikicdn.com/ts/print/c68cf4ba4b.html"
}

Response exception

If something wrong happens, you will receive the error body with explanations.