Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Get a price relay target rule including its connected source rules

GET/api/v1/{team_slug}/{app_slug}/price-relay-target-rules/{rule_id}
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
app_slugstringrequired

App slug

team_slugstringrequired

Team slug

rule_idstringrequired

Target rule ID

Responses
200

Got target rule

datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelayTargetRuleWithSourcesrequired
Show properties
activeboolean
aggregationstring
app_idstring
created_atstring
idstring
marketstring
market_slugstring
namestring
sourcesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelaySourceRule[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelaySourceRule
activeboolean
app_idstring
created_atstring
filtersgithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelayFilters
Show properties
brand_idsstring[] | null
category_idsstring[] | null
collection_idsstring[] | null
tag_idsstring[] | null
force_on_saleboolean | null

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.

idstring
marketstring
market_slugstring
namestring
percentage_of_sourceinteger | null
percentage_of_source_decimalsinteger | null
relay_on_sale_store_groupstring | null

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_groupstring

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.

roundinggithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelayRounding
Show properties
round_downboolean
round_upboolean
targetsstring[] | null
store_groupsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelaySourceStoreGroup[] | null

The store groups whose prices are summed into the relayed price.

Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.PriceRelaySourceStoreGroup
amount_fromstring

The source price field summed into the target's amount_cents_with_tax: 'amount' (the default), 'sale_price' or 'reference_price'.

sale_price_fromstring | null

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_groupstring
store_group_slugstring
tax_country_codestring | null
updated_atstring
store_groupstring
store_group_slugstring
updated_atstring
detailsstring[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

successbooleanrequired
400

Invalid request

detailsstring[]
messagestring
successbooleanrequired
404

Not found

detailsstring[]
messagestring
successbooleanrequired
500

Internal server error

detailsstring[]
messagestring
successbooleanrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v1/string/string/price-relay-target-rules/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "active": true,
    "aggregation": "string",
    "app_id": "string",
    "created_at": "string",
    "id": "string",
    "market": "string",
    "market_slug": "string",
    "name": "string",
    "sources": [
      {
        "active": true,
        "app_id": "string",
        "created_at": "string",
        "filters": {
          "brand_ids": [
            "string"
          ],
          "category_ids": [
            "string"
          ],
          "collection_ids": [
            "string"
          ],
          "tag_ids": [
            "string"
          ]
        },
        "force_on_sale": true,
        "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": true,
          "round_up": true,
          "targets": [
            "string"
          ]
        },
        "store_groups": [
          {
            "amount_from": "string",
            "sale_price_from": "string",
            "store_group": "string",
            "store_group_slug": "string"
          }
        ],
        "tax_country_code": "string",
        "updated_at": "string"
      }
    ],
    "store_group": "string",
    "store_group_slug": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": true
}