Nhảy tới nội dung

Tạo đơn hàng

Cập nhật lần cuối vào

Thông tin HTTP

KeyValue
Content-Typeapplication/json
MethodPOST
Base URLhttps://api.tiki.vn/tiniapp-open-api
Path/order

Request gửi đi phải kèm chữ ký điện tử nhằm đảm bảo tính xác thực. Tham khảo Cách tạo chữ ký điện tử.

HTTP Request

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
customer_idstringID người dùng Tiki, có thể lấy ở đây
items[]ItemDanh sách sản phẩm
customer_infoCustomerInfoThông tin khách hàng, dùng để hiện thị trên trang thanh toán Tiki (phần Thông tin khách hàng)
shipping_feeint64Phí giao hàng
extrastringThông tin bổ sung theo định dạng key=value; key=value
reference_idstringID đơn hàng của đối tác
Lưu ý
  • Giá trị đơn hàng tối đa là mười triệu (10.000.000) đồng. Nếu muốn thay đổi thì cần yêu cầu ở Tini Console.
  • Khi đối tác tạo đơn hàng phía Tiki, không nhất thiết nó phải bao gồm toàn bộ SKU mà đối tác nhận đặt từ khách hàng; chỉ cần gồm 1 hay vài SKU để dại diện thanh toán. Điểm mấu chốt là giá trị đơn hàng phải chính xác.

CustomerInfo

Thuộc tínhKiểu dữ liệuBắt buộcNot NullMô tả
namestringTên khách hàng
phonestringSố điện thoại khách hàng
emailstringEmail khách hàng
streetstringĐịa chỉ khách hàng

Item

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
namestringTên sản phẩm
quantityint64Số lượng sản phẩm
image_urlstringĐường dẫn URL của ảnh sản phẩm
priceint64Giá tiền sản phẩm
extrastringThông tin bổ sung theo định dạng key=value; key=value
metadataMetadataCác thông tin chi tiết liên quan đến sản phẩm

Metadata

Metadata gồm nhiều section.

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
sections[]SectionDanh sách các section

Section

Mỗi section sẽ gồm một header, một hoặc nhiều field.

Thuộc tínhKiểu dữ liệuMô tả
headerstringTiêu đề của section
fields[]FieldDanh sách field nằm trong section đó

Field

Field tương đương một thuộc tính tuỳ biến liên quan đến sản phẩm do đối tác định nghĩa. Sau đây là các thuộc tính của field:

Thuộc tínhKiểu dữ liệuMô tả
typestringKiểu dữ liệu của field
namestringTên field
valueAnyGiá trị của field

Ví dụ về metadata

{
"metadata": {
"sections": [
{
"header": "Thông tin bên gửi",
"fields": [
{
"type": "text",
"name": "Địa chỉ",
"value": "285 Cách Mạng Tháng 8, Phường 12 , Quận 10, TP Hồ Chí Minh."
},
{
"type": "text",
"name": "Người gửi",
"value": "Nguyễn Văn A"
},
{
"type": "text",
"name": "Số điện thoại",
"value": "0761234567"
}
]
},
{
"header": "Thông tin bên nhận",
"fields": [
{
"type": "text",
"name": "Địa chỉ",
"value": "52 Út Tịch, Phường 4, Quận Tân Bình, TP Hồ Chí Minh"
},
{
"type": "text",
"name": "Người nhận",
"value": "Trần Văn B"
},
{
"type": "text",
"name": "Số điện thoại",
"value": "0961234567"
}
]
},

{
"header": "Thông tin món hàng",
"fields": [
{
"type": "text",
"name": "Khối lượng",
"value": "4kg"
},
{
"type": "text",
"name": "Dài x Rộng x Cao",
"value": "12x30x49cm"
},
{
"type": "text",
"name": "Loại hàng hóa",
"value": "Thực phẩm, Quần áo"
},
{
"type": "text",
"name": "Giá trị gói hàng",
"value": "1.000.000 đ"
},
{
"type": "images",
"name": "Hình ảnh gói hàng",
"value": [
"https://salt.tikicdn.com/ts/tiniapp/f9/43/12/d49e6bcba1441f7f985e549e36ad7d83.png",
"https://salt.tikicdn.com/ts/tiniapp/1c/c5/06/a19549329bf09a63711bce03a0d58575.png",
"https://salt.tikicdn.com/ts/tiniapp/26/e2/08/fa7635a27d45fd3f9463a22645a2687b.png"
]
}
]
}
]
}
}
Bank Transfer UML

Ví dụ về metadata với type = action

{
"metadata": {
"sections": [
{
"header": "",
"fields": [
{
"type": "action",
"name": "Giấy chứng nhận điện tử",
"value": {
"button_name": "Xem",
"link": "https://salt.tikicdn.com/ts/tiniapp/b2/6e/d1/2ab2d72f0502596b32c10036a50b54dd.png:"
}
}
]
}
]
}
}
Bank Transfer UML

Ví dụ về yêu cầu tạo đơn hàng

curl --location --request POST 'https://api.tiki.vn/tiniapp-open-api/order/multi-sku' \
--header 'Content-Type: application/json' \
--header 'X-Tiniapp-Client-Id: 8GXqhWDK3EppMwf8IyQU1GHgfq2TPADe' \
--header 'X-Tiniapp-Signature: b1bf71b9519227be3c7cfe2ce7291d07efb7346d0b9917f3e665bd915e09bf3e' \
--header 'X-Tiniapp-Timestamp: 1647507922833' \
--data-raw '{"customer_id":"100102261","items":[{"name":"Dịch vụ Tini Ship","image_url":"https://salt.tikicdn.com/ts/tiniapp/bb/ca/34/128ace153520571b94013f5fdf5fb982.png","quantity":1,"price":220000,"extra":"a=1;b=2","metadata":{"sections":[{"header":"Thông tin bên gửi","fields":[{"type":"text","name":"Địa chỉ","value":"285 Cách Mạng Tháng 8, phường 12, quận 10, TPHCM"},{"type":"text","name":"Người gửi","value":"Tú Bùi"},{"type":"text","name":"Số điện thoại","value":"0901020000"}]},{"header":"Thông tin bên nhận","fields":[{"type":"text","name":"Địa chỉ","value":"Chung cư Tôn Thất Thuyết, phường 1, quận 4, TPHCM"},{"type":"text","name":"Người nhận","value":"Long Nguyễn"},{"type":"text","name":"Số điện thoại","value":"0901021111"}]},{"header":"Thông tin món hàng","fields":[{"type":"text","name":"Khối lường","value":"1kg"},{"type":"text","name":"Dài x Rộng x Cao","value":"12 x 30 x 49 cm"},{"type":"text","name":"Loại hàng hóa","value":"Thực phẩm, Quần áo"},{"type":"text","name":"Giá trị món hàng","value":"1.000.000đ"},{"type":"images","name":"Hình ảnh","value":["https://salt.tikicdn.com/ts/tiniapp/96/ca/8a/f9ca90000a3417e9735a1866ce9f2472.png","https://salt.tikicdn.com/ts/tiniapp/38/e0/27/741bca845eff19cbabdb7588d648364c.png","https://salt.tikicdn.com/ts/tiniapp/e0/72/5d/2c6ff108b9ddec2902dfb47dea6e2695.png"]}]}]}}],"customer_info":{"name":"Tú Bùi","phone":"0901020000","email":"tu.bui@tiki.vn","street":"285 CMT8"},"shipping_fee":0,"extra":"coupon=ABC;note=test","reference_id":"51"}'

---oOo---

HTTP Response

Kết quả lỗi

Thuộc tínhKiểu dữ liệuBắt buộcMô tả
Data[]Data
Data
Thuộc tínhKiểu dữ liệuBắt buộcMô tả
orderOrder
Order
Thuộc tínhKiểu dữ liệuBắt buộcNot NullMô tả
idstringID của đơn hàng ở hệ thống Tini App. Nó đc sinh ra khi khách hàng tạo đơn hàng.
statusstringTrạng thái đơn hàng
grand_totalint64Tổng số tiền mà khách hàng dùng cần thanh toán
tiki_order_idstringID của đơn hàng nằm ở hệ thống Tiki
tiki_order_codestringMã đơn hàng nằm ở hệ thống Tiki dùng cho mục đích đối soát. Nó được sinh ra khi khách hàng thanh toán online đơn hàng.
extrastringThông tin bổ sung theo định dạng key=value;key=value
reference_idstringID đơn hàng của đối tác

Ví dụ về dữ liệu trả về

{
"data": {
"order": {
"id": "141857488587784201",
"extra": "",
"status": "draft",
"grand_total": 35000,
"reference_id": "0",
"tiki_order_id": "",
"tiki_order_code": ""
}
}
}

Khi khách hàng thanh toán bắt đầu thanh toán đơn hàng, JS API my.makePayment sẽ được dùng để mở màn hình thanh toán cho đơn hàng với tham số truyền vào là order ID.