English
English
Appearance
English
English
Appearance
Updating is only allowed when fulfillment_status is one of the following statuses: on_hold, unfulfilled, payment_awaiting, ready
API : /api/integration/orders/:id.json
Method: PATCH
Request Header
| key | value |
|---|---|
| X-pawdo-access-token | API KEY |
Path Params
| key | type | required | note |
|---|---|---|---|
| id | uuid | Required | ID of the order to update |
Request Body
| key | type | required | note |
|---|---|---|---|
| skip_verify_address | boolean | Optional | Skip the address verification step |
| shipping_address | object | Optional | Shipping address information |
| line_items | array object | Optional | List of products to update |
Field Details
shipping_address
| key | type | required | note |
|---|---|---|---|
| name | string | Optional | Recipient name |
| string | Optional | Recipient email | |
| phone | string | Optional | Phone number |
| address1 | string | Optional | Address line 1 |
| address2 | string | Optional | Address line 2 |
| city | string | Optional | City |
| state | string | Optional | State / province |
| country | string | Optional | Country |
| postal_code | string | Optional | Postal code |
| country_code | string | Optional | Country code (ISO) |
| province_code | string | Optional | State / province code |
| option_ship | string | Optional | Shipping method |
| label_ship | url | Optional | Shipping label URL: Required for the TikTok option |
| tax | number | Optional | Tax |
line_items(required)
| key | type | required | note |
|---|---|---|---|
| id | uuid | Required | Line item ID |
| sku | string | Optional | SKU from external system |
| system_sku | string | Required | Internal system SKU |
| 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) |
| quantity | number | Required | Product quantity, min > 0 and max < 1000 |
Example (Request)
{
"skip_verify_address": true,
"shipping_address": {
"tax": 1.2,
"city": "Corryton",
"name": "John Doe",
"email": "[email protected]",
"phone": "",
"state": "Tennessee",
"country": "United States",
"address1": "6056 Whisper Ridge Lane",
"address2": "1234 Whisper Ridge Lane",
"label_ship": "https://example.pdf",
"option_ship": "standard",
"postal_code": "37721",
"country_code": "US",
"province_code": "TN"
},
"line_items": [
{
"id": "b6828234-82ec-47df-88f5-9bc9a81b6ba6",
"sku": "",
"system_sku": "QTR-XS2",
"title": "no title",
"note": "bom ne",
"designs": [
{
"key": "design1",
"design": "https://example.com/design1.png",
"mockup": "https://example.com/mockup1.png"
}
],
"quantity": 13
}
]
}Example (Successful Response)
{
"message": "order updated",
"status": true
}Example (Error Response)
| status code | message | note |
|---|---|---|
| 400 | order cannot be updated in its current fulfillment status | the order is not in one of the 4 statuses allowed for update |
| 400 | a requested lineitem is pending for update, cannot be updated | the line item is awaiting validation of a previous update |
| 400 | a requested lineitem is cancelled, cannot be updated | the line item has been cancelled |
| 404 | order not found | no order found for the given id (or the order does not belong to the API key's store) |
| 422 | invalid system sku: <value> | the system_sku sent does not match any active SKU |
If you need further assistance regarding the API information or its usage, please contact the Pawdo support team via Facebook for assistance.