English
English
Appearance
English
English
Appearance
API: /api/integration/orders.json
Method: POST
Request Header
| key | value |
|---|---|
| X-pawdo-access-token | API KEY |
Request Body (JSON - raw)
| 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 |
| 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
}