Skip to content

API tạo đơn hàng

Tạo đơn hàng thủ công

API : /api/integration/orders.json

Method: POST

Request Header

keyvalue
X-pawdo-access-tokenAPI KEY

Request Body (JSON - raw)

  • Content-Type: application/json
keytyperequirednote
order_numberstringRequiredMã đơn hàng, phải unique
external_transaction_idstringOptionalID giao dịch từ hệ thống ngoài
skip_verify_addressbooleanOptionalBỏ qua bước verify địa chỉ
line_itemsarray objectRequiredDanh sách sản phẩm, tối đa 500 items
addressobjectRequiredThông tin địa chỉ giao hàng

Chi tiết field

address

keytyperequirednote
namestringRequiredTên người nhận
option_shipstringRequiredPhương thức vận chuyển. Danh sách giá trị do hệ thống Pawdo cấu hình (động), phổ biến gồm: standard, express, fast, tiktok, saving.
label_shipurlConditionalNhãn giao hàng. Bắt buộc cho option tiktok
address1stringRequiredĐịa chỉ dòng 1
address2stringOptionalĐịa chỉ dòng 2
citystringOptionalThành phố
statestringOptionalBang /Tỉnh
province_codestringRequiredMã bang / tỉnh
countrystringOptionalQuốc gia
country_codestringRequiredMã quốc gia (ISO)
postal_codestringRequiredMã bưu điện
emailstringOptionalEmail người nhận
phonestringOptionalSố điện thoại

line_items

keytyperequirednote
skustringOptionalSKU từ hệ thống ngoài
system_skustringRequiredSKU nội bộ hệ thống, phải khớp với 1 SKU đang active trong catalog của store
quantitynumberRequiredmin > 0 và max < 1000
titlestringOptionalTên sản phẩm
notestringOptionalGhi chú
designsarray objectOptionalDanh sách thiết kế/mockup của line item, tối đa 15 phần tử. Mỗi phần tử gồm: key (string, định danh slot, ví dụ design1, design2...), design (url, optional — file thiết kế), mockup (url, optional — hình mockup)
option1..option3stringOptionalTùy chọn sản phẩm
external_line_item_idstringOptionalID line item từ hệ thống ngoài

Ràng buộc / Validation

keyrule
order_numberPhải unique, dùng như idempotency key. Nếu đã tồn tại, API trả lỗi 409 Conflict với message order existed
line_itemsTối đa 500 items
line_items[].system_skuBắt buộc, phải khớp SKU đang active trong catalog
line_items[].quantitymin > 0 và max < 1000
address.address1, address.province_code, address.postal_code, address.country_code, address.name, address.option_shipBắt buộc

Example (Request)

json
{
  "order_number": "#ORDER-056487",
  "external_transaction_id": "TS-9283023921",
  "skip_verify_address": true,
  "line_items": [
    {
      "sku": "QTR-XS2",
      "system_sku": "QTR-XS2",
      "quantity": 5,
      "title": "",
      "note": "",
      "designs": [ 
        { 
          "key": "design1",
          "design": "https://example.com/design1.png", 
          "mockup": "https://example.com/mockup1.png"
        } 
      ], 
      "option1": "",
      "option2": "",
      "option3": "",
      "external_line_item_id": "LI-1048273842"
    }
  ],
  "address": {
    "name": "John Doe",
    "option_ship": "standard",
    "label_ship": "",
    "address1": "123 Main Street",
    "address2": "Apartment 4B",
    "city": "Los Angeles",
    "province_code": "CA",
    "country": "United States",
    "country_code": "US",
    "postal_code": "90001",
    "email": "[email protected]",
    "phone": ""
  }
}

Example (Response thành công)

json
{
  "data": {
    "order_id": "d33e0745-***-9fb1-01ac3e5135c3"
  },
  "message": "ok",
  "status": true
}

Example (Response lỗi)

status codemessagenote
400bad requestbody sai định dạng hoặc thiếu field required (order_number, line_items, address.name, address.option_ship, address.address1, address.province_code, address.country_code, address.postal_code, line_items[].system_sku, line_items[].quantity)
400unsupported shipping optionoption_ship không khớp option nào đang active trong hệ thống
409order existedorder_number đã tồn tại trong store
422invalid system sku: <giá trị>system_sku không khớp SKU nào đang active trong catalog của store

Nếu có bất kỳ vấn đề nào liên quan đến api đơn hàng, vui lòng liên hệ với bộ phận support của Pawdo qua Facebook để được hỗ trợ.