Bulk Create Attribute-Item Relationships

Associates multiple attributes with multiple items in a single operation. Each relationship links one attribute to one or more items. Validates attribute existence before creating relationships. Returns lists of successful and failed associations with detailed error reasons.

POST/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk

Associates multiple attributes with multiple items in a single operation. Each relationship links one attribute to one or more items. Validates attribute existence before creating relationships. Returns lists of successful and failed associations with detailed error reasons.

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: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/attributes/relationships/bulk
  • Summary: Bulk Create Attribute-Item Relationships
  • Description: Associates multiple attributes with multiple items in a single operation. Each relationship links one attribute to one or more items. Validates attribute existence before creating relationships. Returns lists of successful and failed associations with detailed error reasons.
  • 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.

Parameters2 parameters
NameInRequiredTypeDescription
team_slugpathYesstringTeam slug
app_slugpathYesstringApp slug
Request bodyDocumented body
  • Required: Yes
  • Description: Attribute-item relationships to create (max 50)
  • Content: application/json (object)

Bulk Modify Attribute Relationships Payload

PropertyTypeRequiredDetails
itemsobject[]YesmaxItems: 50

Bulk Attribute Relationship Item

PropertyTypeRequiredDetails
attribute_idstringYes-
item_idsstring[]YesminItems: 1

Generated example (synthetic):

{
  "items": [
    {
      "attribute_id": "string",
      "item_ids": [
        "string"
      ]
    }
  ]
}
Responses4 statuses
StatusDescriptionContent
200Relationships processed successfullyapplication/json (object)
400Invalid request payloadapplication/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Bulk Add Attribute Relationships 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-
Bulk Add Attribute Relationships
PropertyTypeRequiredDetails
failed_addsobject[]No-
successful_addsobject[]No-
Bulk Attribute Relationship Failed Op
PropertyTypeRequiredDetails
attribute_idstringNo-
item_idstringNo-
reasonstringNo-
Bulk Attribute Relationship Item
PropertyTypeRequiredDetails
attribute_idstringYes-
item_idsstring[]YesminItems: 1

Generated example (synthetic):

{
  "data": {
    "failed_adds": [
      {
        "attribute_id": "string",
        "item_id": "string",
        "reason": "string"
      }
    ],
    "successful_adds": [
      {
        "attribute_id": "string",
        "item_ids": []
      }
    ]
  },
  "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
}

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: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/attributes/relationships/bulk
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Attributes, Bulk
  • OpenAPI summary: Bulk Create Attribute-Item Relationships

Bulk Create Attribute-Item Relationships

# Bulk Create Attribute-Item Relationships Associates multiple attributes with multiple items in a single operation. Each relationship links one attribute to one or more items. Validates attribute existence before creating relationships. Returns lists of successful and failed associations with detailed error reasons.
POST /api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk
Purpose

Associates multiple attributes with multiple items in a single operation.

Required inputs

team_slug path app_slug path

Primary response

200 ยท Relationships processed successfully

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk

## 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: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk` - Summary: Bulk Create Attribute-Item Relationships - Description: Associates multiple attributes with multiple items in a single operation. Each relationship links one attribute to one or more items. Validates attribute existence before creating relationships. Returns lists of successful and failed associations with detailed error reasons. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | team_slug | path | Yes | string | Team slug | | app_slug | path | Yes | string | App slug | ## Request body - Required: Yes - Description: Attribute-item relationships to create (max 50) - Content: application/json (object) ### Bulk Modify Attribute Relationships Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `items` | object[] | Yes | maxItems: 50 | #### Bulk Attribute Relationship Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `attribute_id` | string | Yes | - | | `item_ids` | string[] | Yes | minItems: 1 | **Generated example (synthetic):** ```json { "items": [ { "attribute_id": "string", "item_ids": [ "string" ] } ] } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | Relationships processed successfully | application/json (object) | | 400 | Invalid request payload | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Bulk Add Attribute Relationships 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 | - | ##### Bulk Add Attribute Relationships | Property | Type | Required | Details | | --- | --- | --- | --- | | `failed_adds` | object[] | No | - | | `successful_adds` | object[] | No | - | ##### Bulk Attribute Relationship Failed Op | Property | Type | Required | Details | | --- | --- | --- | --- | | `attribute_id` | string | No | - | | `item_id` | string | No | - | | `reason` | string | No | - | ##### Bulk Attribute Relationship Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `attribute_id` | string | Yes | - | | `item_ids` | string[] | Yes | minItems: 1 | **Generated example (synthetic):** ```json { "data": { "failed_adds": [ { "attribute_id": "string", "item_id": "string", "reason": "string" } ], "successful_adds": [ { "attribute_id": "string", "item_ids": [] } ] }, "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 } ``` ### 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: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/attributes/relationships/bulk` - OpenAPI tag: Attributes, Bulk - OpenAPI summary: Bulk Create Attribute-Item Relationships