Customer Item Price Override

The customer item price override resource.

Basehttps://rest.carbon.ms/customerItemPriceOverride

GET/customerItemPriceOverride

List customer item price overrides

Retrieve a paginated list of customer item price overrides. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/customerItemPriceOverride

curl --request GET \
  --url 'https://rest.carbon.ms/customerItemPriceOverride?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "itemId": "xyz789",
    "active": true,
    "applyRulesOnTop": true,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "customerId": "xyz789"
  }
]

GET/customerItemPriceOverride

Retrieve a customer item price override

Fetch a single customer item price override by filtering on `id`.

Query parameters

idstring

Match on the customer item price override's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/customerItemPriceOverride

curl --request GET \
  --url 'https://rest.carbon.ms/customerItemPriceOverride?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "active": true,
  "applyRulesOnTop": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "customerId": "xyz789"
}

POST/customerItemPriceOverride

Create a customer item price override

Create a new customer item price override.

Body parameters

customerIdstring

References customer.id

customerTypeIdstring

References customerType.id

itemIdstringrequired

References item.id

notesstring

validFromdate

validTodate

activebooleanrequired

applyRulesOnTopbooleanrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/customerItemPriceOverride

curl --request POST \
  --url https://rest.carbon.ms/customerItemPriceOverride \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","active":true,"applyRulesOnTop":true,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "active": true,
  "applyRulesOnTop": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "customerId": "xyz789"
}

PATCH/customerItemPriceOverride

Update a customer item price override

Update an existing customer item price override, matched on `id`.

Body parameters

customerIdstring

References customer.id

customerTypeIdstring

References customerType.id

itemIdstringrequired

References item.id

notesstring

validFromdate

validTodate

activebooleanrequired

applyRulesOnTopbooleanrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/customerItemPriceOverride

curl --request PATCH \
  --url 'https://rest.carbon.ms/customerItemPriceOverride?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"customerId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "active": true,
  "applyRulesOnTop": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "customerId": "xyz789"
}

DELETE/customerItemPriceOverride

Delete a customer item price override

Delete a customer item price override, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the customer item price override to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/customerItemPriceOverride

curl --request DELETE \
  --url 'https://rest.carbon.ms/customerItemPriceOverride?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content