Update a price adjustment

PATCH

/v1/pricing/adjustments/{id}

• Production API

Partially update an existing price adjustment. Send only the fields you want to change (e.g. status, targets, effect, conditions). Server-controlled fields (companyId, id, created, changed) are stripped from the body. The adjustment must belong to the authenticated company. Changing a coupon conditions.code to one already used by another active adjustment returns 409.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Example

padj_123abc

The price adjustment ID.

Request Body ^required

A partial PriceAdjustment — any subset of mutable fields.

Placeholder schema for PriceAdjustment. Add it to the schemaMap in scripts/create-content/api-docs.mjs for a richer definition.

object

Example

{
  "status": "inactive"
}

Responses

200

The updated price adjustment record

object

status

string

Example

ok

data

Placeholder schema for PriceAdjustment. Add it to the schemaMap in scripts/create-content/api-docs.mjs for a richer definition.

object

400

Validation failed — the patch did not satisfy the schema

object

status

string

Example

error

message

string

Example

An error occurred

error

string

401

Unauthorized — a valid bearer token is required

object

status

string

Example

error

message

string

Example

An error occurred

error

string

403

Forbidden — the adjustment belongs to a different company

object

status

string

Example

error

message

string

Example

An error occurred

error

string

404

Not found — no such adjustment

object

status

string

Example

error

message

string

Example

An error occurred

error

string

409

Conflict — the new coupon code is already taken

object

status

string

Example

error

message

string

Example

An error occurred

error

string

500

Internal server error

object

status

string

Example

error

message

string

Example

An error occurred

error

string