Add products to collection

Adds one or more products to a collection. Validates that products exist and are not deleted before association.

PUT/api/v1/{team_slug}/{app_slug}/collections/{collection_id}/products

management-api:PUT:/api/v1/{team_slug}/{app_slug}/collections/{collection_id}/products

Adds one or more products to a collection. Validates that products exist and are not deleted before association.

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\}/collections/\{collection_id\}/products
Summary: Add products to collection
Description: Adds one or more products to a collection. Validates that products exist and are not deleted before association.
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
collection_id	path	Yes	string	ID of collection

Request bodyDocumented body

Property	Type	Required	Details
`product_ids`	string[]	Yes	-

Generated example (synthetic):

{
  "product_ids": [
    "string"
  ]
}

Responses5 statuses

Status	Description	Content
200	Collection updated 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)

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
}

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.

API family: Management API
Method: PUT
Path: /api/v1/\{team_slug\}/\{app_slug\}/collections/\{collection_id\}/products
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Collections
OpenAPI summary: Add products to collection