Customer Item Price Override Break

The customer item price override break resource.

Basehttps://rest.carbon.ms/customerItemPriceOverrideBreak

GET/customerItemPriceOverrideBreak

List customer item price override breaks

Retrieve a paginated list of customer item price override breaks. 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/customerItemPriceOverrideBreak

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

Response

[
  {
    "id": "abc123def456",
    "customerItemPriceOverrideId": "xyz789",
    "quantity": 10,
    "overridePrice": 0,
    "active": true,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/customerItemPriceOverrideBreak

Retrieve a customer item price override break

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

Query parameters

idstring

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

GEThttps://rest.carbon.ms/customerItemPriceOverrideBreak

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

Response

{
  "id": "abc123def456",
  "customerItemPriceOverrideId": "xyz789",
  "quantity": 10,
  "overridePrice": 0,
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/customerItemPriceOverrideBreak

Create a customer item price override break

Create a new customer item price override break.

Body parameters

customerItemPriceOverrideIdstringrequired

quantitynumberrequired

overridePricenumberrequired

activebooleanrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/customerItemPriceOverrideBreak

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

Response

{
  "id": "abc123def456",
  "customerItemPriceOverrideId": "xyz789",
  "quantity": 10,
  "overridePrice": 0,
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/customerItemPriceOverrideBreak

Update a customer item price override break

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

Body parameters

customerItemPriceOverrideIdstringrequired

quantitynumberrequired

overridePricenumberrequired

activebooleanrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/customerItemPriceOverrideBreak

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

Response

{
  "id": "abc123def456",
  "customerItemPriceOverrideId": "xyz789",
  "quantity": 10,
  "overridePrice": 0,
  "active": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/customerItemPriceOverrideBreak

Delete a customer item price override break

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/customerItemPriceOverrideBreak

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

204 No Content