Price list fixed surcharges

Fixed modifier option surcharges in price lists: for one variant of the item or for all, in the price list currency and in store money.

Loading the search index…

Price list fixed surcharges

Objects

PriceListModifierItem

  • idintegerrequired

    ID of the record, unique among records of its kind in the store.

  • price_list_idintegerrequired

    Price list ID.

  • modifier_option_idintegerrequired

    Modifier option ID.

  • variant_idinteger or nullrequired

    Variant of the item the surcharge is specific to; null — the surcharge applies to all variants.

  • price_deltaintegerrequired

    Option surcharge in minor units of currency: the assigned surcharge in store money.

  • list_price_deltainteger or nullrequired

    Surcharge as the owner set it, in minor units of list_price_currency; null — set in store money (price_delta).

  • list_price_currencystring or nullrequired

    Currency of the assigned surcharge; null — the surcharge is in the store currency.

  • currencystringrequired

    Currency of the amounts, an ISO 4217 code: the currency of the store.

  • created_atstring (date-time)required

    When the record was created.

  • updated_atstring (date-time)required

    When the record last changed.

Endpoints

List fixed modifier option surcharges in price lists changed since a given moment

get/price-list-modifier-items

Scope: catalog:read

Parameters

Query

  • limitinteger

    Page size: up to 250 records; 50 by default.

    Minimum:
    1
    Maximum:
    250
  • cursorstring

    Opaque cursor: next_cursor of the previous page, or sync_cursor of the last page saved by the previous sync. The list goes in commit order, so the sync cursor later returns only what changed after it.

    Max length:
    4096
  • updated_sincestring (date-time)

    Only records changed after this moment, ISO 8601 with a time zone. A filter for the first sync; continue with the cursor.

    Pattern:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — also return deleted records: archived ones with deleted_at set, and records erased from the database as tombstones {id, deleted_at} in the continuation by the sync cursor. Turn it on for a sync.

  • price_list_idinteger

    Only surcharges of this price list.

    Minimum:
    1
  • modifier_option_idinteger

    Only surcharges of this option across all lists.

    Minimum:
    1

Responses

200Success

application/json

  • dataarray of PriceListModifierItemrequired

    Records of the page.

  • deletedarray of objectrequired

    Records erased from the database since the cursor, as tombstones: only with include_deleted=true in the continuation by the sync cursor.

    Fields · 2
    • idintegerrequired

      ID of the erased record.

    • deleted_atstring (date-time)required

      When the record was erased.

  • next_cursorstring or nullrequired

    Cursor of the next page; null on the last page.

  • has_morebooleanrequired

    true when there is a next page.

  • sync_cursorstring or nullrequired

    On the last page — the cursor to continue from later: it returns only what changed after this page. null on other pages.

401The token is missing, invalid, expired or revoked

Headers

  • WWW-Authenticatestringrequired

    Authentication scheme (RFC 6750).

    Example:
    Bearer

application/problem+json

Returns Problem

403The plan, the IP address or the token scopes do not allow the request

Headers

  • WWW-Authenticatestring

    Authentication scheme (RFC 6750).

    Example:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Returns ForbiddenProblem

410The sync cursor is older than the deletion retention period or was issued before the database was restored

application/problem+json

Returns Problem

422A parameter is invalid or unknown

application/problem+json

Returns ValidationProblem

429The rate limit is exhausted

Headers

  • Retry-Afterintegerrequired

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns RateLimitProblem

503The store is temporarily unavailable

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns Problem

Errors of this endpoint

Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors

Example request
curl "https://api.saleya.app/v1/price-list-modifier-items" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Example response · 200
{
  "data": [
    {
      "id": 0,
      "price_list_id": 0,
      "modifier_option_id": 0,
      "variant_id": 0,
      "price_delta": 0,
      "list_price_delta": 0,
      "list_price_currency": "string",
      "currency": "string",
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Get a fixed option surcharge in a price list

get/price-list-modifier-items/{price_list_modifier_item}

Scope: catalog:read

Parameters

Path

  • price_list_modifier_itemintegerrequired

    Price list fixed surcharge ID.

Responses

200Success

application/json

Returns PriceListModifierItem

401The token is missing, invalid, expired or revoked

Headers

  • WWW-Authenticatestringrequired

    Authentication scheme (RFC 6750).

    Example:
    Bearer

application/problem+json

Returns Problem

403The plan, the IP address or the token scopes do not allow the request

Headers

  • WWW-Authenticatestring

    Authentication scheme (RFC 6750).

    Example:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Returns ForbiddenProblem

404The object does not exist or is not available to the app

application/problem+json

Returns Problem

422A parameter is invalid or unknown

application/problem+json

Returns ValidationProblem

429The rate limit is exhausted

Headers

  • Retry-Afterintegerrequired

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns RateLimitProblem

503The store is temporarily unavailable

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns Problem

Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors

Example request
curl "https://api.saleya.app/v1/price-list-modifier-items/{price_list_modifier_item}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Example response · 200
{
  "id": 0,
  "price_list_id": 0,
  "modifier_option_id": 0,
  "variant_id": 0,
  "price_delta": 0,
  "list_price_delta": 0,
  "list_price_currency": "string",
  "currency": "string",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Set fixed modifier option surcharges in a price list in bulk

post/price-lists/{price_list}/modifier-items

Scope: catalog:writeororders:wholesale

Parameters

Path

  • price_liststringrequired

    Price list ID.

Header

  • Idempotency-Keystring

    Unique key of the attempt, for example a UUID. A retry with the same key and body gets the saved response instead of a second write. Keys live 24 hours.

    Min length:
    1
    Max length:
    255
    Example:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringrequired

    ETag of the record from the last read, for example "7". The change applies only if nobody changed the record since then; otherwise 412. Without it — 428.

    Example:
    "7"

Request body application/json

  • itemsarray of objectrequired

    Fixed surcharges, up to 1000 per request, each option and variant pair once. An existing row gets the new surcharge; the batch is written in full or not at all.

    Min items:
    1
    Max items:
    1000
    Fields · 4
    • modifier_option_idintegerrequired

      Modifier option ID (/v1/modifier-groups).

    • variant_idinteger or null

      Variant the surcharge applies to; null or omitted — all of the item's variants. The variant's item must offer the option.

    • price_deltainteger or null

      Surcharge in minor units of the store currency, may be negative — for a row priced in store money: the row's list_price_currency is null, for a new row — the option's.

      Minimum:
      -10000000000
      Maximum:
      10000000000
    • list_price_deltainteger or null

      Surcharge in minor units of the price list currency, may be negative — for a row priced in that currency. The store money amount is converted by the system.

      Minimum:
      -10000000000
      Maximum:
      10000000000

Responses

200Success

Headers

  • Idempotent-Replayedstring

    true when this is the saved response of an earlier request with the same Idempotency-Key.

    Values:
    true
  • ETagstringrequired

    Version of the record. Send it in If-Match to change the record.

    Example:
    "7"

application/json

Returns PriceList

401The token is missing, invalid, expired or revoked

Headers

  • WWW-Authenticatestringrequired

    Authentication scheme (RFC 6750).

    Example:
    Bearer

application/problem+json

Returns Problem

403The plan, the IP address or the token scopes do not allow the request

Headers

  • WWW-Authenticatestring

    Authentication scheme (RFC 6750).

    Example:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Returns ForbiddenProblem

404The object does not exist or is not available to the app

application/problem+json

Returns Problem

409A request with the same idempotency key is in progress, the data changed after it was read, the external ID belongs to another record, the plan or webhook endpoint limit is reached, or the change needs consent to its consequences

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns ConflictProblem

412The record changed after it was read: the version in If-Match is not current

application/problem+json

Returns Problem

422A parameter is invalid or unknown

application/problem+json

Returns ValidationProblem

428The request needs If-Match with the ETag of the record

application/problem+json

Returns Problem

429The rate limit is exhausted

Headers

  • Retry-Afterintegerrequired

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns RateLimitProblem

503The store is temporarily unavailable

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns Problem

Errors of this endpoint

Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors

Example request
curl -X POST "https://api.saleya.app/v1/price-lists/{price_list}/modifier-items" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Request body — body.json
{
  "items": [
    {
      "modifier_option_id": 0,
      "variant_id": 0,
      "price_delta": 0,
      "list_price_delta": 0
    }
  ]
}
Example response · 200
{
  "id": 0,
  "version": 0,
  "kind": "location",
  "name": "string",
  "adjustment_bp": 0,
  "rounding": {
    "mode": "nearest",
    "precision": 0
  },
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Remove fixed modifier option surcharges from a price list in bulk

post/price-lists/{price_list}/modifier-items/remove

Scope: catalog:writeororders:wholesale

Parameters

Path

  • price_liststringrequired

    Price list ID.

Header

  • Idempotency-Keystring

    Unique key of the attempt, for example a UUID. A retry with the same key and body gets the saved response instead of a second write. Keys live 24 hours.

    Min length:
    1
    Max length:
    255
    Example:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringrequired

    ETag of the record from the last read, for example "7". The change applies only if nobody changed the record since then; otherwise 412. Without it — 428.

    Example:
    "7"

Request body application/json

  • itemsarray of objectrequired

    Fixed surcharges to remove, up to 1000 per request. A pair without a fixed surcharge is skipped.

    Min items:
    1
    Max items:
    1000
    Fields · 2
    • modifier_option_idintegerrequired

      Modifier option ID.

    • variant_idinteger or null

      Variant whose surcharge to remove; null or omitted — the surcharge for all variants.

Responses

200Success

Headers

  • Idempotent-Replayedstring

    true when this is the saved response of an earlier request with the same Idempotency-Key.

    Values:
    true
  • ETagstringrequired

    Version of the record. Send it in If-Match to change the record.

    Example:
    "7"

application/json

Returns PriceList

401The token is missing, invalid, expired or revoked

Headers

  • WWW-Authenticatestringrequired

    Authentication scheme (RFC 6750).

    Example:
    Bearer

application/problem+json

Returns Problem

403The plan, the IP address or the token scopes do not allow the request

Headers

  • WWW-Authenticatestring

    Authentication scheme (RFC 6750).

    Example:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Returns ForbiddenProblem

404The object does not exist or is not available to the app

application/problem+json

Returns Problem

409A request with the same idempotency key is in progress, the data changed after it was read, the external ID belongs to another record, the plan or webhook endpoint limit is reached, or the change needs consent to its consequences

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns ConflictProblem

412The record changed after it was read: the version in If-Match is not current

application/problem+json

Returns Problem

422A parameter is invalid or unknown

application/problem+json

Returns ValidationProblem

428The request needs If-Match with the ETag of the record

application/problem+json

Returns Problem

429The rate limit is exhausted

Headers

  • Retry-Afterintegerrequired

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns RateLimitProblem

503The store is temporarily unavailable

Headers

  • Retry-Afterinteger

    Seconds to wait before retrying.

    Minimum:
    0

application/problem+json

Returns Problem

Errors of this endpoint

Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors

Example request
curl -X POST "https://api.saleya.app/v1/price-lists/{price_list}/modifier-items/remove" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Request body — body.json
{
  "items": [
    {
      "modifier_option_id": 0,
      "variant_id": 0
    }
  ]
}
Example response · 200
{
  "id": 0,
  "version": 0,
  "kind": "location",
  "name": "string",
  "adjustment_bp": 0,
  "rounding": {
    "mode": "nearest",
    "precision": 0
  },
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}