DocsDocsReference

Add a product to a relation

Add an existing product to an existing product relation

PUT/api/v1/{team_slug}/{app_slug}/relations/{relation_id}/{product_id}
API
Management
Updated
Apr 26, 2026

management-api:PUT:/api/v1/{team_slug}/{app_slug}/relations/{relation_id}/{product_id}

Add an existing product to an existing product relation

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: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/relations/\{relation_id\}/\{product_id\}
  • Summary: Add a product to a relation
  • Description: Add an existing product to an existing product relation
  • 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
relation_idpathYesstringRelation ID
product_idpathYesstringProduct ID
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses5 statuses
StatusDescriptionContent
200Product added to relation successfullyapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
422Invalid request and not parsable by backendapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Relation Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Relation
PropertyTypeRequiredDetails
directionstringNo-
idstringNo-
primary_product_idstringNo-
productsobject[]No-
titlestringNo-
typestringNo-
type_idstringNo-
Relation Product
PropertyTypeRequiredDetails
descriptionstringNo-
idstringNo-
image_urlstringNo-
product_namestringNo-
product_numberstringNo-
slugstringNo-

Generated example (synthetic):

{
  "data": {
    "direction": "string",
    "id": "string",
    "primary_product_id": "string",
    "products": [
      {
        "description": "string",
        "id": "string",
        "image_url": "string",
        "product_name": "string",
        "product_number": "string",
        "slug": "string"
      }
    ],
    "title": "string",
    "type": "string",
    "type_id": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

422 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

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: PUT
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/relations/\{relation_id\}/\{product_id\}
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Relations
  • OpenAPI summary: Add a product to a relation

Add a product to a relation

# Add a product to a relation Add an existing product to an existing product relation
PUT /api/v1/{team_slug}/{app_slug}/relations/{relation_id}/{product_id}
Purpose

Add an existing product to an existing product relation

Required inputs

app_slug path team_slug path relation_id path product_id path

Primary response

200 ยท Product added to relation successfully

Operation key

management-api:PUT:/api/v1/{team_slug}/{app_slug}/relations/{relation_id}/{product_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}/relations/{relation_id}/{product_id}` - Summary: Add a product to a relation - Description: Add an existing product to an existing product relation - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/relations/{relation_id}/{product_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 | | relation_id | path | Yes | string | Relation ID | | product_id | path | Yes | string | Product ID | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Product added to relation successfully | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 422 | Invalid request and not parsable by backend | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Relation Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `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 | No | - | ##### Relation | Property | Type | Required | Details | | --- | --- | --- | --- | | `direction` | string | No | - | | `id` | string | No | - | | `primary_product_id` | string | No | - | | `products` | object[] | No | - | | `title` | string | No | - | | `type` | string | No | - | | `type_id` | string | No | - | ##### Relation Product | Property | Type | Required | Details | | --- | --- | --- | --- | | `description` | string | No | - | | `id` | string | No | - | | `image_url` | string | No | - | | `product_name` | string | No | - | | `product_number` | string | No | - | | `slug` | string | No | - | **Generated example (synthetic):** ```json { "data": { "direction": "string", "id": "string", "primary_product_id": "string", "products": [ { "description": "string", "id": "string", "image_url": "string", "product_name": "string", "product_number": "string", "slug": "string" } ], "title": "string", "type": "string", "type_id": "string" }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 422 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **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 | No | - | **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}/relations/{relation_id}/{product_id}` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:PUT:/api/v1/{team_slug}/{app_slug}/relations/{relation_id}/{product_id}` - OpenAPI tag: Relations - OpenAPI summary: Add a product to a relation