Creates relationships between an image and up to 100 items (products or variants) with optional priority ordering. Validates that each item exists and is not deleted before creating the relationship. Returns lists of successful and failed relationship creations with error details.

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\}/images/\{image_id\}/relationships/bulk
• Summary: Bulk Add Image Relationships
• Description: Creates relationships between an image and up to 100 items (products or variants) with optional priority ordering. Validates that each item exists and is not deleted before creating the relationship. Returns lists of successful and failed relationship creations with error details.
• 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.

{
  "items": [
    {
      "item_id": "string",
      "item_type": "product",
      "priority": 1
    }
  ]
}

{
  "data": {
    "failed": [
      {
        "item_id": "string",
        "item_type": "string",
        "reason": "string"
      }
    ],
    "successful": [
      {
        "item_id": "string",
        "item_type": "product",
        "priority": 1
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

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

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

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

{
  "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\}/images/\{image_id\}/relationships/bulk
• Operation ID: Not documented in the OpenAPI contract.
• OpenAPI tag: Images, Bulk
• OpenAPI summary: Bulk Add Image Relationships