Create image relationship

Creates a new relationship between an image and a product or variant with optional priority ordering

PUT/api/v1/{team_slug}/{app_slug}/images/{image_id}/relationship

management-api:PUT:/api/v1/{team_slug}/{app_slug}/images/{image_id}/relationship

Creates a new relationship between an image and a product or variant with optional priority ordering

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.

Method: PUT
Path: /api/v1/\{team_slug\}/\{app_slug\}/images/\{image_id\}/relationship
Summary: Create image relationship
Description: Creates a new relationship between an image and a product or variant with optional priority ordering
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.

Parameters3 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
image_id	path	Yes	string	Image ID

Request bodyDocumented body

Property	Type	Required	Details
`item_id`	string	Yes	-
`item_type`	enum("product", "variant")	Yes	-
`priority`	integer	No	min: 1 Priority of the image, i.e. the order in which it should be displayed

Generated example (synthetic):

{
  "item_id": "string",
  "item_type": "product",
  "priority": 1
}

Responses4 statuses

Property	Type	Required	Details
`data`	string	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	-

Generated example (synthetic):

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

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

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

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

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

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

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

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