Skip to main content
POST
/
orders
/
{id}
/
adjustments
Apply an order-level adjustment (discount, fee, or coupon)
curl --request POST \
  --url https://api.arcuserp.com/v1/orders/{id}/adjustments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Summer Promo 10%",
  "effect_type": "discount",
  "discount_type": "percentage",
  "value": 10,
  "notes": "Applied via API integration - summer campaign"
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

​
Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

​
id
string<uuid>
required

UUID of the order to apply the adjustment to.

Body

application/json
​
name
string
required

Display label for the adjustment (e.g. "Summer Promo 10%", "Rush Fee").

​
effect_type
enum<string>
required

Whether this adjustment reduces (discount) or increases (fee) the order total.

Available options:
discount,
fee
​
discount_type
enum<string>
required

How value is interpreted.

Available options:
percentage,
fixed_amount
​
value
number
required

Numeric value. For percentage, 0--100. For fixed_amount, a dollar amount.

​
coupon_id
string<uuid>

Optional. If provided, applies the named coupon instead of a manual adjustment.

​
notes
string

Optional internal notes.

​
applied_by
string<uuid>

UUID of the user applying the adjustment. Defaults to API key owner if omitted.

Response

Adjustment applied and order totals recalculated.

The created adjustment row with updated order total.