Availabilities per week

In the 2025v2 Release, we are changing how Availabilities for Catalog Prices are set. Supplier organizations will be able to set Availabilities per week when using Catalog Prices. Previously, the availabilities could only be set for the current week and the next week. This update replaces the previous endpoints for changing and retrieving availabilities with new endpoints for setting and retrieving Availabilities per week.



Supported scenarios

  • Set trade item availabilities per week
  • Sync trade item availabilities per week

📘

Retrieving the availabilities per week can now only be done with a Sync endpoint. Synchronizing the availability data allows you to keep a real time overview of all the availabilities of all the trade items.

This means that we no longer support the GET endpoint for retrieving the availability data of a single trade item.



Set trade item availabilities per week

Setting the trade item availabilities per week is done with the EditTradeItemAvailabilityPerWeek endpoint.

The endpoint contains the following properties. A description of the properties is listed below.

{
  "tradeItemIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "fromWeek": {
    "week": 0,
    "year": 0
  },
  "tillWeek": {
    "week": 0,
    "year": 0
  },
  "isAvailable": true,
  "alwaysAvailableForCustomerOrganizationIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "neverAvailableForCustomerOrganizationIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}
  • tradeItemIds: Multiple tradeItemIds may be listed in one request. This sets the availabilities for all the listed tradeItemIds at once.
  • fromWeek, tillWeek: The availabilities per week are set based on a 'from' and 'till' method.
    • For instance, if fromWeek has the value "week": 3 and tillWeek has the value "week": 15. The availability of the trade item will be changed for week 3 up to and including week 15.
  • isAvailable: This sets the availability of the trade item(s) to either true or false.
  • alwaysAvailableForCustomerOrganizationIds: This allows supplier organizations to set an exception for specific customer organizations. This makes it so that the trade item availability is always true for those customer organizations, regardless of the status of isAvailable.
  • neverAvailableForCustomerOrganizationIds: In the same vein, this property makes it so that the trade item availability is always false for the listed customer organizations, regardless of the status of isAvailable.
💡

fromWeek and tillWeek can only be set once per request. In order to set multiple, seperate weeks (i.e. week 3 - 15 and week 18 - 24), seperate requests must be made.



Sync trade item availabilities per week

Synchronizing the trade item availabilities per week is done with the GetTradeItemAvailabilitiesPerWeekBySequenceNumber endpoint.

The endpoint contains the following properties. Properties that may require further explanation are listed below.

{
  "maximumSequenceNumber": 0,
  "results": [
    {
      "tradeItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "week": 0,
      "year": 0,
      "isAvailable": true,
      "alwaysAvailableForCustomerOrganizationIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "neverAvailableForCustomerOrganizationIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "sequenceNumber": 0
    }
  ]
}

  • week,year: The availability is listed seperately per week. For instance,
  • isAvailable: This sets the availability of the trade item(s) to either true or false.
  • alwaysAvailableForCustomerOrganizationIds: This allows supplier organizations to set an exception for specific customer organizations. This makes it so that the trade item availability is always true for those customer organizations, regardless of the status of isAvailable.
  • neverAvailableForCustomerOrganizationIds: In the same vein, this property makes it so that the trade item availability is always false for the listed customer organizations, regardless of the status of isAvailable.