Order creation API

Create an 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, must be unique
external_transaction_id	string	Optional	Transaction ID from an external system
skip_verify_address	boolean	Optional	Skip the address verification step
line_items	array object	Required	List of products, up to 500 items
address	object	Required	Shipping address information

---

Field Details

address

key	type	required	note
name	string	Required	Recipient name
option_ship	string	Required	Shipping method. The list of values is configured (dynamically) by the Pawdo system; common ones include: standard, express, fast, tiktok, saving.
label_ship	url	Conditional	Shipping label. Required for the tiktok option
address1	string	Required	Address line 1
address2	string	Optional	Address line 2
city	string	Optional	City
state	string	Optional	State / province
province_code	string	Required	State / province code
country	string	Optional	Country
country_code	string	Required	Country code (ISO)
postal_code	string	Required	Postal code
email	string	Optional	Recipient email
phone	string	Optional	Phone number

---

line_items

key	type	required	note
sku	string	Optional	SKU from an external system
system_sku	string	Required	Internal system SKU, must match an active SKU in the store's catalog
quantity	number	Required	min > 0 and max < 1000
title	string	Optional	Product title
note	string	Optional	Note
designs	array object	Optional	List of designs/mockups for the line item, up to 15 elements. Each element contains: key (string, slot identifier, e.g. design1, design2...), design (url, optional — design file), mockup (url, optional — mockup image)
option1..option3	string	Optional	Product options
external_line_item_id	string	Optional	Line item ID from an external system

---

Constraints / Validation

key	rule
order_number	Must be unique, used as an idempotency key. If it already exists, the API returns a 409 Conflict error with the message order existed
line_items	Up to 500 items
line_items[].system_sku	Required, must match an active SKU in the catalog
line_items[].quantity	min > 0 and max < 1000
address.address1, address.province_code, address.postal_code, address.country_code, address.name, address.option_ship	Required

---

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": "",
      "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 (Successful Response)

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

Example (Error Response)

status code	message	note
400	bad request	body is malformed or missing a required field (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)
400	unsupported shipping option	option_ship does not match any active option in the system
409	order existed	order_number already exists in the store
422	invalid system sku: <value>	system_sku does not match any active SKU in the store's catalog

If you encounter any issues related to the order API, please contact the Pawdo support team via Facebook for assistance.