API for order

Import order by file CSV

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

Method: POST

Request Header

key	value
X-pawdo-access-token	API KEY

Request Body

key	type
order_name	string
name	string
quantity	uint64
mockup1	string
mockup2	string
mockup3	string
mockup4	string
design1	string
design2	string
design3	string
design4	string
email	string
address1	string
address2	string
city	string
country	string
full_name	string
phone	string
province	string
zip	string
company	string
province_code	string
ioss_num	string
sku_code	string
properties	string
variant_id	string
variant_option1	string
variant_option2	string
variant_option3	string
financial_status	string
shipping_line	string
note	string
resource	string

Example

{
  "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)

Case where all orders are valid:

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

Case where there are invalid orders:

{
  "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"
      }
    ]
  }
}

• Upon successful order creation, navigate to the Order List interface to verify the information.
• Alternatively, retrieve the order list using the API documented below.

Create Order Manually

API: /api/integration/orders.json

Method: POST

Request Header

key	value
X-pawdo-access-token	API KEY

---

Request Body (JSON - raw)

• Content-Type: application/json

key	type	required	note
order_number	string	Required	Order number / reference – must be unique
external_transaction_id	string	Optional	External transaction ID (from another system)
skip_verify_address	boolean	Optional	Skip address verification step
line_items	array of objects	Required	List of products (maximum 500 items)
address	object	Required	Shipping address information

---

Field Details

address

key	type	required	note
name	string	Required	Recipient's name
option_ship	string	Required	Shipping method: standard, express, fast, tiktok
label_ship	url	Conditional	Shipping label URL – required when option_ship is tiktok
address1	string	Optional	Address line 1
address2	string	Optional	Address line 2
city	string	Optional	City
state	string	Optional	Bang /Tỉnh
province_code	string	Optional	State / Province code
country	string	Optional	Country name
country_code	string	Required	Country code (ISO 3166-1 alpha-2)
postal_code	string	Optional	ZIP / Postal code
email	string	Optional	Recipient's email
phone	string	Optional	Phone number

---

line_items

key	type	required	note
sku	string	Optional	SKU from external system
system_sku	string	Optional	Internal system SKU
quantity	number	Required	Quantity (min > 0, max < 1000)
title	string	Optional	Product title / name
note	string	Optional	Internal note / remark
mockup1..mockup4	url	Optional	Mockup image URLs (1 to 4)
design1..design4	url	Optional	Design file URLs (1 to 4)
option1..option3	string	Optional	Product variant options
external_line_item_id	string	Optional	External line item ID (from another system)

---

Constraints / Validation Rules

key	rule
order_number	Must be unique – used as idempotency key
line_items	Maximum 500 items
line_items[].quantity	Must be > 0 and < 1000

---

Example (Request)

{
  "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 successfully)

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