Documentation Index

Fetch the complete documentation index at: https://docs.wair.ai/llms.txt

Use this file to discover all available pages before exploring further.

POST /Collections

  • Updated on Jan 27, 2026
  • Published on Jan 20, 2026
  • 2 minute(s) read
Prev Next

GENERAL INFORMATION

Purpose

This endpoint is used for sharing product collection information.

How the data is used

The collection information is  throughout the customer portal so users are able to filter on this collection of quickly identify the collection of the products in the overview:

This enables users to gain insights of the products of that collection so they are able to make decisions and/or create (automated) actions in the customer portal based on the collection information. This makes it a highly recommended dataset to share.

Best practices

  1. Make sure to update the collection on a regular basis, recommended minimum once a day, to ensure the collection information is complete and in-line with the collections assigned to the items.

  2. Ensure that the id you are using in this endpoint aligns with the collectionId you are assigning to the items in this endpoint POST /Items

  3. The collection (also called drop, capsule, or delivery window) is used to provide basic context about when and how a group of products is launched.

  4. We recommend to also link the collection to a season so the users in our portal are able to apply business rules both on season (for example the products from 2025 Winter season) and the corresponding collection (for example the products 2025 Winter season that have dropped in the first month).

Common pitfalls

  1. Do not generated a random id for the collectionId field in the integration, only use system generated id’s that are fixed in the source system, as you need the same id to also be able to be able to update the collection information.

  2. A common pitfall is to send a system generated like a guid in the code field, which can make it unclear for users in our customer portal to see which collection they are looking at.

  3. Also make sure that if you are sending a seasonId, it is also the same id as you are sending to the POST /Seasons endpoint.

Example use cases

  1. As a merchandiser I want to filter on the products in the collection that has launched last month so I can monitor performance of these products and apply additional replenishment rules based on their performance.

  2. As an inventory manager, I want to see which items within the previous collection are underperforming so I can redistribute excess stock to stores where demand is higher.

TECHNICAL INFORMATION

Authentication

Bearer token, information on page POST /Token

Headers

Name

Description

Example

X-Tenant

Tenant code supplied by Wair

“TENANT”

QueryParameters:

Name

Description

Example

fullLoad

See documentation: Integration core principles

true

Body example:

{
  "collections": [
    {
      "collectionId": "e8a007b0-af0e-4f7e-9e78-1f067e29f4fe",
      "code": "W25-6",
      "description": "Winter 2025 drop 6",
      "seasonId": "81066054-6c6c-4f92-a8b0-2aa0c751e311"
    },
    {
      "collectionId": "8dfa4993-c905-4fa7-b561-aa5ef4cc8425",
      "code": "W25-7",
      "description": "Winter 2025 drop 7",
      "seasonId": "81066054-6c6c-4f92-a8b0-2aa0c751e311"
    }
  ]
}

Field information:

Fieldname

Context

Mandatory

Type / max characters

collectionId

Unique identifier for this collection, for example a guid, needs to be unique across all collections. If you want to update a collection, send the collection again using this id.

Yes

string / 80 characters

code

A business key, often user defined, of the collection

YES

string / 60 characters max

description

The short description of the collection

No, but highly preferred

string / 255 characters max

seasonId

the id of the season of which this collection is connected to.

No

string / 80 characters

RESPONSE

StatusCodes:

200 = OK

401 = Unauthorized, which means an expired/missing/invalid token

400 = Bad request, see body of the response to check which validation errors have occured

500 = System error, see body of the response to check which error has occured or contact integration support

Body Example:

No body in the response

Related articles