Skip to main content
PATCH
Update fulfillment status

Authorizations

Authorization
string
header
required

API key from the Rigaly dashboard: Authorization: Bearer rgly_sk_...

Path Parameters

id
string<uuid>
required

Body

application/json
status
enum<string>
required
Available options:
shipped,
delivered,
cancelled
tracking_reference
string | null
Maximum string length: 255
Example:

"1Z999AA10123456784"

refund_points
boolean
default:true

Only read when status is cancelled. Defaults to true: the points the customer spent are credited straight back to their balance. Send false to cancel without a refund — for example when you have already settled with the customer some other way, or the goods were delivered and later returned under your own returns policy.

Response

Fulfillment updated

success
boolean
Example:

true

message
string
data
object