Skip to content

Update Order (Integration)

Only allow updating 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 be updated

Request Body

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

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 TikTok option
taxnumberOptionalTax

line_items(required)

keytyperequirednote
iduuidRequiredLine item ID
skustringOptionalSKU from external system
system_skustringRequiredInternal system SKU
titlestringOptionalProduct title
notestringOptionalNote
mockup1..mockup4urlOptionalMockup image URLs
design1..design4urlOptionalDesign file URLs
quantitynumberRequiredProduct quantity

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": "3456 *** Ridge Lane",
    "address2": "1234 *** Ridge Lane",
    "label_ship": "https://example.pdf",
    "option_ship": "standard",
    "postal_code": "12345",
    "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",
      "mockup1": "https://example.com/mockup1.png",
      "mockup2": "",
      "mockup3": "",
      "mockup4": "",
      "design1": "https://example.com/design1.png",
      "design2": "",
      "design3": "",
      "design4": "",
      "quantity": 13
    }
  ]
}

Example (Response successfully)

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

If you need further assistance regarding the API information or its usage, please contact Pawdo support via Facebook for assistance.