Skip to content

API tạo đơn hàng

Nhập đơn hàng từ file CSV

API : /api/integration/orders/import.json

Method: POST

Request Header

keyvalue
X-pawdo-access-tokenAPI KEY

Request body

keytype
order_namestring
namestring
quantityuint64
mockup1string
mockup2string
mockup3string
mockup4string
design1string
design2string
design3string
design4string
emailstring
address1string
address2string
citystring
countrystring
full_namestring
phonestring
provincestring
zipstring
companystring
province_codestring
ioss_numstring
sku_codestring
propertiesstring
variant_idstring
variant_option1string
variant_option2string
variant_option3string
financial_statusstring
shipping_linestring
notestring
resourcestring

Example

json
{
  "data": [
    {
      "mockup1": "https://example.com/mockup1.jpg",
      "mockup2": "https://example.com/mockup2.jpg",
      "mockup3": "https://example.com/mockup3.jpg",
      "mockup4": "https://example.com/mockup4.jpg",

      "design1": "https://example.com/design1.jpg",
      "design2": "https://example.com/design2.jpg",
      "design3": "https://example.com/design3.jpg",
      "design4": "https://example.com/design4.jpg",

      "order_number": "ORDER-10001",
      "type": "tshirt",
      "title": "Custom T-Shirt",
      "sku": "TS-RED-M",
      "system_sku": "SYS-TS-0001",
      "quantity": 2,
      "tag": "summer-collection",

      "option1": "Red",
      "option2": "Medium",
      "option3": "Cotton",

      "name": "Nguyen Van A",
      "option_ship": "standard",
      "label_ship": "https://example.pdf",
      "address1": "123 Nguyen Trai",
      "address2": "Ward 5",
      "city": "Ho Chi Minh",
      "state": "District 1",
      "province_code": "HCM",
      "country": "Vietnam",
      "country_code": "VN",
      "postal_code": "700000",
      "email": "[email protected]",
      "phone": "012345678",
      "tax": 1.5,

      "thank_card": "Yes",
      "brand_kit_a5": "Included",
      "brand_kit_a5_clothes": "Included",
      "brand_kit_a6": "Not Included",
      "note": "Please print logo on front side.",

      "external_transaction_id": "TXN-123456789",
      "reference_id2": "REF-ABC-001"
    }
  ],
  "note": ""
}

Example (Response)

Trường hợp tất cả đơn hợp lệ:

json
{
  "status": true,
  "data": {
    "total": 1,
    "valid": 1,
    "invalid": 0,
    "invalid_orders": []
  }
}

Trường hợp có đơn hàng không hợp lệ:

json
{
  "status": true,
  "data": {
    "total": 2,
    "valid": 1,
    "invalid": 1,
    "invalid_orders": [
      {
        "mockup1": "https://example.com/mockup1.jpg",
        "order_number": "ORDER-10002",
        "type": "tshirt",
        "title": "Custom T-Shirt",
        "sku": "TS-RED-M",
        "system_sku": "SYS-TS-0001",
        "quantity": 1,
        "tag": "summer-collection",
        "option1": "Red",
        "option2": "Medium",
        "option3": "Cotton",
        "name": "Nguyen Van B",
        "option_ship": "standard",
        "label_ship": "",
        "address1": "123 Nguyen Trai",
        "address2": "",
        "city": "Ho Chi Minh",
        "state": "District 1",
        "province_code": "",
        "country": "Vietnam",
        "country_code": "VN",
        "postal_code": "700000",
        "email": "[email protected]",
        "phone": "012345678",
        "tax": 0,
        "thank_card": "",
        "brand_kit_a5": "",
        "brand_kit_a5_clothes": "",
        "brand_kit_a6": "",
        "note": "",
        "external_transaction_id": "",
        "reference_id2": "",
        "error": "Invalid data: ProvinceCode is required"
      }
    ]
  }
}
  • Sau khi tạo đơn hàng thành công, người dùng vào giao diện Danh sách đơn hàng để kiểm tra thông tin
  • Hoặc sử dụng api dưới đây để lấy danh sách thông tin order

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: standard, express, fast, tiktok
label_shipurlConditionalNhãn giao hàng: Bắt buộc cho option tiktok
address1stringOptionalĐịa chỉ dòng 1
address2stringOptionalĐịa chỉ dòng 2
citystringOptionalThành phố
statestringOptionalBang /Tỉnh
province_codestringOptionalMã bang / tỉnh
countrystringOptionalQuốc gia
country_codestringRequiredMã quốc gia (ISO)
postal_codestringOptionalMã 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_skustringOptionalSKU nội bộ hệ thống
quantitynumberRequiredmin > 0 và max < 1000
titlestringOptionalTên sản phẩm
notestringOptionalGhi chú
mockup1..mockup4urlOptionalURL hình mockup
design1..design4urlOptionalURL file thiết kế
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
line_itemsTối đa 500 items
line_items[].quantitymin > 0 và max < 1000

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": "",
      "mockup1": "https://example.com/mockup1.png",
      "mockup2": "",
      "mockup3": "",
      "mockup4": "",
      "design1": "https://example.com/design1.png",
      "design2": "",
      "design3": "",
      "design4": "",
      "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
}

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ợ.