Update a price relay source rule
# Update a price relay source rule
Update a price relay source rule
PUT
/api/v1/{team_slug}/{app_slug}/price-relay-source-rules/{rule_id}
PurposeUpdate a price relay source rule
Required inputsapp_slug path team_slug path rule_id path
Primary response200 ยท source rule updated
Operation keymanagement-api:PUT:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules/{rule_id}
## 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: `PUT`
- Path: `/api/v1/{team_slug}/{app_slug}/price-relay-source-rules/{rule_id}`
- Summary: Update a price relay source rule
- Description: Update a price relay source rule
- OpenAPI contract:
management-api
- Operation ID: Not documented in the OpenAPI contract.
- Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules/{rule_id}`
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 |
| rule_id | path | Yes | string | Source rule ID |
## Request body
- Required: Yes
- Description: source rule details
- Content: application/json (object)
### Input Price Relay Source Rule
| Property | Type | Required | Details |
| --- | --- | --- | --- |
| `active` | boolean | 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. |
| `market_slug` | string | Yes | - |
| `name` | string | Yes | - |
| `percentage_of_source` | integer | No | - |
| `percentage_of_source_decimals` | integer | No | - |
| `relay_on_sale_store_group_slug` | string | No | When set, the target inherits its on-sale flag and sale window from this store group's price; omit to leave the target's own. Must be one of store_groups. |
| `relay_status_store_group_slug` | string | Yes | 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[] | Yes | minItems: 1 The store groups whose prices are summed into the relayed price. |
| `tax_country_code` | string | No | - |
#### Input Price Relay Filters
| Property | Type | Required | Details |
| --- | --- | --- | --- |
| `brand_ids` | string[] | No | uniqueItems |
| `category_ids` | string[] | No | uniqueItems |
| `collection_ids` | string[] | No | uniqueItems |
| `tag_ids` | string[] | No | uniqueItems |
#### Input Price Relay Rounding
| Property | Type | Required | Details |
| --- | --- | --- | --- |
| `round_down` | boolean | No | - |
| `round_up` | boolean | No | - |
| `targets` | string[] | No | - |
#### Input 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 summed into the target's sale_price_with_tax: 'amount', 'sale_price' or 'reference_price'. Omit to contribute this store group's amount to the summed sale price. |
| `store_group_slug` | string | Yes | - |
**Generated example (synthetic):**
```json
{
"active": false,
"filters": {
"brand_ids": [
"string"
],
"category_ids": [
"string"
],
"collection_ids": [
"string"
],
"tag_ids": [
"string"
]
},
"force_on_sale": false,
"market_slug": "string",
"name": "string",
"percentage_of_source": 0,
"percentage_of_source_decimals": 0,
"relay_on_sale_store_group_slug": "string",
"relay_status_store_group_slug": "string",
"rounding": {
"round_down": false,
"round_up": false,
"targets": [
"string"
]
},
"store_groups": [
{
"amount_from": "string",
"sale_price_from": "string",
"store_group_slug": "string"
}
],
"tax_country_code": "string"
}
```
## Responses
| Status | Description | Content |
| --- | --- | --- |
| 200 | source rule updated | application/json (object) |
| 400 | Invalid request | application/json (object) |
| 404 | Not found | application/json (object) |
| 500 | Internal server error | application/json (object) |
### 200 - object
#### Price Relay Source Rule Response
| Property | Type | Required | Details |
| --- | --- | --- | --- |
| `data` | object | Yes | - |
| `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes |
| `success` | boolean | Yes | - |
##### 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": [
"string"
],
"category_ids": [
"string"
],
"collection_ids": [
"string"
],
"tag_ids": [
"string"
]
},
"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": [
"string"
]
},
"store_groups": [
{
"amount_from": "string",
"sale_price_from": "string",
"store_group": "string",
"store_group_slug": "string"
}
],
"tax_country_code": "string",
"updated_at": "string"
},
"details": [
"string"
],
"success": false
}
```
### 400 - 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
}
```
### 404 - 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
}
```
### 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: `PUT`
- Path: `/api/v1/{team_slug}/{app_slug}/price-relay-source-rules/{rule_id}`
- Operation ID: Not documented in the OpenAPI contract.
- Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/price-relay-source-rules/{rule_id}`
- OpenAPI tag: Price Relay Rules
- OpenAPI summary: Update a price relay source rule
