Skip to content

API for order

Create Order Manually

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_numberstringRequiredOrder number / reference – must be unique
external_transaction_idstringOptionalExternal transaction ID (from another system)
skip_verify_addressbooleanOptionalSkip address verification step
line_itemsarray of objectsRequiredList of products (maximum 500 items)
addressobjectRequiredShipping address information

Field Details

address

keytyperequirednote
namestringRequiredRecipient's name
option_shipstringRequiredShipping method: standard, express, fast, tiktok
label_shipurlConditionalShipping label URL – required when option_ship is tiktok
address1stringOptionalAddress line 1
address2stringOptionalAddress line 2
citystringOptionalCity
statestringOptionalBang /Tỉnh
province_codestringOptionalState / Province code
countrystringOptionalCountry name
country_codestringRequiredCountry code (ISO 3166-1 alpha-2)
postal_codestringOptionalZIP / Postal code
emailstringOptionalRecipient's email
phonestringOptionalPhone number

line_items

keytyperequirednote
skustringOptionalSKU from external system
system_skustringOptionalInternal system SKU
quantitynumberRequiredQuantity (min > 0, max < 1000)
titlestringOptionalProduct title / name
notestringOptionalInternal note / remark
mockup1..mockup4urlOptionalMockup image URLs (1 to 4)
design1..design4urlOptionalDesign file URLs (1 to 4)
option1..option3stringOptionalProduct variant options
external_line_item_idstringOptionalExternal line item ID (from another system)

Constraints / Validation Rules

keyrule
order_numberMust be unique – used as idempotency key
line_itemsMaximum 500 items
line_items[].quantityMust be > 0 and < 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 successfully)

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