List price relay source rules with pagination

List price relay source rules with pagination

GET/api/v1/{team_slug}/{app_slug}/price-relay-source-rules
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules

List price relay source rules with pagination

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules
  • Summary: List price relay source rules with pagination
  • Description: List price relay source rules with pagination
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters4 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
pagequeryNointegerPage number (default is 1)
per-pagequeryNointegerAmount per page (default is 20)
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses2 statuses
StatusDescriptionContent
200List of source rulesapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Price Relay Source Rule List

PropertyTypeRequiredDetails
dataobject[]Yes-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Price Relay Source Rule
PropertyTypeRequiredDetails
activebooleanNo-
app_idstringNo-
created_atstringNo-
filtersobjectNo-
force_on_salebooleanNoOverrides the target's on-sale flag with this value; when omitted the flag is left to relay_on_sale_store_group and the target's own state.
idstringNo-
marketstringNo-
market_slugstringNo-
namestringNo-
percentage_of_sourceintegerNo-
percentage_of_source_decimalsintegerNo-
relay_on_sale_store_groupstringNoWhen set, the target inherits its on-sale flag and sale window from this store group's price; null leaves the target's own. Must be one of store_groups.
relay_status_store_groupstringNoThe target inherits its status from this store group's price; falls back to the target's own status, or the source status when the target has no price yet. Must be one of store_groups.
roundingobjectNo-
store_groupsobject[]NoThe store groups whose prices are summed into the relayed price.
tax_country_codestringNo-
updated_atstringNo-
Price Relay Filters
PropertyTypeRequiredDetails
brand_idsstring[]No-
category_idsstring[]No-
collection_idsstring[]No-
tag_idsstring[]No-
Price Relay Rounding
PropertyTypeRequiredDetails
round_downbooleanNo-
round_upbooleanNo-
targetsstring[]No-
Price Relay Source Store Group
PropertyTypeRequiredDetails
amount_fromstringNoThe source price field summed into the target's amount_cents_with_tax: 'amount' (the default), 'sale_price' or 'reference_price'.
sale_price_fromstringNoThe source price field that feeds the target's sale_price_with_tax: 'amount', 'sale_price' or 'reference_price'. Null contributes this store group's amount to the summed sale price.
store_groupstringNo-
store_group_slugstringNo-
{
  "data": [
    {
      "active": false,
      "app_id": "string",
      "created_at": "string",
      "filters": {
        "brand_ids": [],
        "category_ids": [],
        "collection_ids": [],
        "tag_ids": []
      },
      "force_on_sale": false,
      "id": "string",
      "market": "string",
      "market_slug": "string",
      "name": "string",
      "percentage_of_source": 0,
      "percentage_of_source_decimals": 0,
      "relay_on_sale_store_group": "string",
      "relay_status_store_group": "string",
      "rounding": {
        "round_down": false,
        "round_up": false,
        "targets": []
      },
      "store_groups": [
        {
          "amount_from": null,
          "sale_price_from": null,
          "store_group": null,
          "store_group_slug": null
        }
      ],
      "tax_country_code": "string",
      "updated_at": "string"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanYes-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/price-relay-source-rules
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Price Relay Rules
  • OpenAPI summary: List price relay source rules with pagination

List price relay source rules with pagination

# List price relay source rules with pagination List price relay source rules with pagination
GET /api/v1/{team_slug}/{app_slug}/price-relay-source-rules
Purpose

List price relay source rules with pagination

Required inputs

app_slug path team_slug path

Primary response

200 ยท List of source rules

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/price-relay-source-rules` - Summary: List price relay source rules with pagination - Description: List price relay source rules with pagination - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | page | query | No | integer | Page number (default is 1) | | per-page | query | No | integer | Amount per page (default is 20) | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | List of source rules | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Price Relay Source Rule List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | Yes | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Price Relay Source Rule | Property | Type | Required | Details | | --- | --- | --- | --- | | `active` | boolean | No | - | | `app_id` | string | No | - | | `created_at` | string | No | - | | `filters` | object | No | - | | `force_on_sale` | boolean | No | Overrides the target's on-sale flag with this value; when omitted the flag is left to relay_on_sale_store_group and the target's own state. | | `id` | string | No | - | | `market` | string | No | - | | `market_slug` | string | No | - | | `name` | string | No | - | | `percentage_of_source` | integer | No | - | | `percentage_of_source_decimals` | integer | No | - | | `relay_on_sale_store_group` | string | No | When set, the target inherits its on-sale flag and sale window from this store group's price; null leaves the target's own. Must be one of store_groups. | | `relay_status_store_group` | string | No | The target inherits its status from this store group's price; falls back to the target's own status, or the source status when the target has no price yet. Must be one of store_groups. | | `rounding` | object | No | - | | `store_groups` | object[] | No | The store groups whose prices are summed into the relayed price. | | `tax_country_code` | string | No | - | | `updated_at` | string | No | - | ##### Price Relay Filters | Property | Type | Required | Details | | --- | --- | --- | --- | | `brand_ids` | string[] | No | - | | `category_ids` | string[] | No | - | | `collection_ids` | string[] | No | - | | `tag_ids` | string[] | No | - | ##### Price Relay Rounding | Property | Type | Required | Details | | --- | --- | --- | --- | | `round_down` | boolean | No | - | | `round_up` | boolean | No | - | | `targets` | string[] | No | - | ##### Price Relay Source Store Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `amount_from` | string | No | The source price field summed into the target's amount_cents_with_tax: 'amount' (the default), 'sale_price' or 'reference_price'. | | `sale_price_from` | string | No | The source price field that feeds the target's sale_price_with_tax: 'amount', 'sale_price' or 'reference_price'. Null contributes this store group's amount to the summed sale price. | | `store_group` | string | No | - | | `store_group_slug` | string | No | - |
Generated example (synthetic) ```json { "data": [ { "active": false, "app_id": "string", "created_at": "string", "filters": { "brand_ids": [], "category_ids": [], "collection_ids": [], "tag_ids": [] }, "force_on_sale": false, "id": "string", "market": "string", "market_slug": "string", "name": "string", "percentage_of_source": 0, "percentage_of_source_decimals": 0, "relay_on_sale_store_group": "string", "relay_status_store_group": "string", "rounding": { "round_down": false, "round_up": false, "targets": [] }, "store_groups": [ { "amount_from": null, "sale_price_from": null, "store_group": null, "store_group_slug": null } ], "tax_country_code": "string", "updated_at": "string" } ], "success": false, "total": 0, "total_pages": 0 } ```
### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | Yes | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/price-relay-source-rules` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules` - OpenAPI tag: Price Relay Rules - OpenAPI summary: List price relay source rules with pagination