Skip to main content
PUT
/
api
/
v1
/
orders
/
:id
Update Order
curl --request PUT \
  --url https://api.launchmystore.io/api/v1/orders/:id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "tags": [
    {}
  ],
  "email": "<string>",
  "phone": "<string>",
  "shipping_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "company": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "country": "<string>",
    "zip": "<string>",
    "phone": "<string>"
  },
  "billing_address": {},
  "note_attributes": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "success": true,
  "data": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.launchmystore.io/llms.txt

Use this file to discover all available pages before exploring further.

Update Order

Updates an existing order. Only certain fields can be modified after order creation.

Request

curl -X PUT "https://api.launchmystore.io/api/v1/orders/ord_abc123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Updated shipping instructions",
    "tags": ["VIP", "priority"],
    "shipping_address": {
      "address1": "456 Oak Ave",
      "city": "Los Angeles",
      "province": "CA",
      "zip": "90001"
    }
  }'

Path Parameters

id
string
required
The unique order ID

Body Parameters

note
string
Order notes
tags
array
Array of tags (replaces existing tags)
email
string
Customer email address
phone
string
Customer phone number
shipping_address
object
Updated shipping address
billing_address
object
Updated billing address (same structure as shipping_address)
note_attributes
array
Additional order attributes

Response

success
boolean
Whether the request succeeded
data
object
The updated order object

Example Response

{
  "success": true,
  "data": {
    "id": "ord_abc123",
    "order_number": 1001,
    "email": "customer@example.com",
    "status": "confirmed",
    "financial_status": "paid",
    "fulfillment_status": "unfulfilled",
    "note": "Updated shipping instructions",
    "tags": ["VIP", "priority"],
    "shipping_address": {
      "first_name": "John",
      "last_name": "Doe",
      "address1": "456 Oak Ave",
      "city": "Los Angeles",
      "province": "CA",
      "country": "US",
      "zip": "90001"
    },
    "created_at": "2024-01-20T14:30:00Z",
    "updated_at": "2024-01-25T16:00:00Z"
  }
}

Notes

  • Line items cannot be modified after order creation
  • Financial status can only be changed through payment or refund operations
  • Fulfillment status is managed through the Fulfill Order endpoint
  • Orders that are already shipped may have restrictions on address changes

Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing access token
FORBIDDENApp doesn’t have write_orders scope
NOT_FOUNDOrder with the specified ID does not exist
VALIDATION_ERRORInvalid request body
ORDER_CLOSEDCannot modify a closed or cancelled order