Skip to main content
PATCH
/
api
/
v1
/
orders
/
{id}
Update order
curl --request PATCH \
  --url https://shelfforce.ai/api/v1/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "draft",
  "supplierName": "<string>",
  "expectedDeliveryDate": "2023-12-25",
  "notes": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "orderNumber": "<string>",
    "status": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Path Parameters

id
string
required

Order ID

Body

application/json
status
enum<string>
Available options:
draft,
pending,
confirmed,
shipped,
delivered,
cancelled
supplierName
string
expectedDeliveryDate
string<date>
notes
string

Response

Order updated.

data
object