Skip to main content
PUT
/
v2
/
orders
/
{merchant_id}
cURL
curl --request PUT \
  --url https://api.loyaltylion.com/v2/orders/{merchant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_status": "not_paid",
  "refund_status": "not_refunded",
  "cancellation_status": "cancelled",
  "total_paid": "99.99",
  "total_refunded": "59.99",
  "$magento_payload": "<unknown>"
}
'
"<string>"
Use this endpoint to update an existing order in LoyaltyLion, using your internal (from your ecommerce platform) merchant_id to identify the order. This is a full update and must include the order’s current payment, cancellation and refund status, including any relevant totals if required (total_paid and total_refunded). The update endpoint is idempotent, so it’s safe to call it every time an order is updated in your system.

Authorizations

​
Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Path Parameters

​
merchant_id
string
required
Minimum string length: 1

Body

application/json

Body

​
payment_status
enum<string>
required
Available options:
not_paid,
partially_paid,
paid
​
refund_status
enum<string>
required
Available options:
not_refunded,
partially_refunded,
refunded
​
cancellation_status
enum<string>
required
Available options:
cancelled,
not_cancelled
​
total_paid
required

The total amount paid for the order as a decimal string without formatting, e.g. 99.99

Example:

"99.99"

​
total_refunded
required

The total amount refunded for the order as a decimal string without formatting, e.g. 59.99

Example:

"59.99"

​
$magento_payload
any

Response

204

The response is of type string.

Allowed value: ""