PriceTier

List the company's price tiers, newest first (by creation time). A price tier lowers the price of a matching sales order item — it applies to an order item only when every one of the tier's populated conditions is met. Soft-deleted tiers are excluded, and so are tiers your team restrictions hide. Tiers outside their active window are still listed; the window only governs whether a tier applies to orders, not whether it appears here.

Filter with company_relationship_id (a customer condition), product_ids (a product condition), or search (substring on the internal name). When several filters are supplied a tier must satisfy all of them (AND).

Results are paginated. Walk pages by following the response's next_page URL; it is null on the last page.

Required permission: settings_permissions_price_tiers.

get/public/v1/price-tiers

Request

  • Base URL
    https://app.distru.com
  • Auth
    HTTP bearer

Query parameters

idsstring[]

Restrict the result to specific price tiers by ID (the same ID returned as each price tier's id). Repeat the bracketed key once per ID. Unknown IDs simply match nothing; an empty list is treated as no filter. At most 200 IDs may be given.

company_relationship_idstring

Return only tiers that include this customer in a customer condition. The ID of a company relationship (customer). Matches a tier whose "one of these customers" condition lists this id exactly; tiers with no customer condition, or that only exclude this customer, are not returned.

product_idsstring[]

Return only tiers that explicitly list any of these products in their product condition (the same products returned under a tier's conditions.one_of_products). Repeat the bracketed key once per product ID; matches ANY. Tiers with no product condition — all-products tiers, or those scoped by category/brand/group — are not returned, nor are tiers that only exclude these products. A malformed ID is rejected with a 400; an unknown-but-well-formed ID matches nothing; an empty list is no filter. At most 200 IDs.

searchstring

Case-insensitive substring match on the tier's internal name. Does not search external_name.

inserted_datetimestring

Filter to price tiers by their creation datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range: 2022-07-10T00:00:00Z, matches on or after that instant, ,2022-07-10T00:00:00Z matches on or before it.

updated_datetimestring

Filter to price tiers by their last-updated datetime, given as a comma-separated start,end pair of ISO8601 datetimes (inclusive). Either bound may be omitted for an open-ended range.

owner_idsstring[]

Restrict to price tiers owned by any of these Distru users (each tier's owner.id). Repeat the bracketed key once per ID; matches ANY. Unknown IDs match nothing; an empty list is no filter. At most 200 IDs.

pagestring

Page selector. Page size is fixed by the server; paginate by following the next_page URL in each response rather than building page selectors yourself — it is null on the last page. next_page uses page[after]=<cursor>, an opaque token marking where the next page resumes; pass it back exactly as given, and only to the endpoint that issued it. This is seek-based, so every page stays fast no matter how deep you page.

Response

A list of price tiers

next_pagestring

URL for the next page of results; null when there is no next page

Changes

    • info

      added the non-success response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status