v3

latestOpenAPI 3.0.1raw.githubusercontent.com2025-11-0572035.1 KB
public

Given a list of Product names, return all the products that are releasable.

Business Rules:

Only Products that are releasable at the date of the request will be returned.

If valid Products are requested then Product exchange set with baseline data including requested Products will be returned.

If a requested Product has been cancelled or replaced, then the replacement Product will not be included in the response payload. Only the specific Products requested will be returned.

If none of the Products requested exist then exchange set with baseline releasable data without requested Products will be returned.

post/v2/exchangeSet/s100/productNames

Query parameters

callbackUristring

An optional callback URI that will be used to notify the requestor once the requested Exchange Set is ready to download from the File Share Service. The data for the notification will follow the CloudEvents 1.0 standard, with the data portion containing the same Exchange Set data as the response to the original API request. If not specified, then no call back notification will be sent. Must be a valid HTTPS endpoint.

Headers

X-Correlation-IDstring required

Unique GUID.

Request body

string[] required

Response

Request to create Exchange Set is accepted. Response body has Exchange Set status URL to track changes to the status of the task. It also contains the URL that the Exchange Set will be available on as well as the number of products in that Exchange Set.

If none of the requested products are available, then status code 202 ('Accepted') will be returned with an empty Exchange Set and the exchangeSetProductCount will be 0.

If a requested Product has been cancelled or replaced, then the replacement Product will not be included in the response payload. Only the specific Products requested will be returned.

exchangeSetUrlExpiryDateTimestring date-time
{"stackTrail":"components:schemas:ProductCount","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ProductCount","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:ProductCount","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:MissingProductList","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:BatchId","oasType":"schema","type":"unknown"}