Skip to content

Update Order (Integration)

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

keyvalue
X-pawdo-access-tokenAPI KEY

Path Params

keytyperequirednote
iduuidRequiredID of the order to update

Request Body

  • Content-Type: application/json
keytyperequirednote
skip_verify_addressbooleanOptionalSkip the address verification step
shipping_addressobjectOptionalShipping address information
line_itemsarray objectOptionalList of products to update

Field Details

shipping_address

keytyperequirednote
namestringOptionalRecipient name
emailstringOptionalRecipient email
phonestringOptionalPhone number
address1stringOptionalAddress line 1
address2stringOptionalAddress line 2
citystringOptionalCity
statestringOptionalState / province
countrystringOptionalCountry
postal_codestringOptionalPostal code
country_codestringOptionalCountry code (ISO)
province_codestringOptionalState / province code
option_shipstringOptionalShipping method
label_shipurlOptionalShipping label URL: Required for the TikTok option
taxnumberOptionalTax

line_items(required)

keytyperequirednote
iduuidRequiredLine item ID
skustringOptionalSKU from external system
system_skustringRequiredInternal system SKU
titlestringOptionalProduct title
notestringOptionalNote
designsarray objectOptionalList 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)
quantitynumberRequiredProduct quantity, min > 0 and max < 1000

Example (Request)

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

json
{
  "message": "order updated",
  "status": true
}

Example (Error Response)

status codemessagenote
400order cannot be updated in its current fulfillment statusthe order is not in one of the 4 statuses allowed for update
400a requested lineitem is pending for update, cannot be updatedthe line item is awaiting validation of a previous update
400a requested lineitem is cancelled, cannot be updatedthe line item has been cancelled
404order not foundno order found for the given id (or the order does not belong to the API key's store)
422invalid 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.