Get all product categories
POST /api/connector/v1/productCategories/getAll
Returns all categories of products. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of ProductCategory.
Unique identifiers of Service to which the product categories belong.
Interval in which the product categories were updated.
object
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "ProductCategoryIds": [ "5228623e-b2cf-4f9f-8bd6-71cbe3ec5e6f", "63bc87d3-edf5-4d06-a601-6052a2ad709d" ], "ServiceIds": [ "9b3a6c54-63aa-4383-b50e-b0030078184b", "c0f71466-6c0b-4993-88ac-1794f6b7e958" ], "UpdatedUtc": { "StartUtc": "2023-05-05T00:00:00Z", "EndUtc": "2023-05-10T00:00:00Z" }, "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
Product categories.
object
Unique identifier of the product category.
Unique identifier of the enterprise to which the product category belongs.
Unique identifier of the Service of the resource category.
All translations of the name.
object
All translations of the short name.
object
All translations of the description.
object
Parent product category, if set.
object
Unique identifier of the product category.
All translations of the name.
object
Date and time of the product category update in UTC timezone in ISO 8601 format.
Date and time of the product category creation in UTC timezone in ISO 8601 format.
Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed).
Unique identifier of the last product category returned. This can be used in Limitation in a subsequent request to fetch the next batch of product categories.
Example
{ "ProductCategories": [ { "Id": "5c0804f9-d03a-4b13-a57d-b00300781a41", "ServiceId": "9b3a6c54-63aa-4383-b50e-b0030078184b", "Names": { "en-US": "Alcohol 1" }, "ShortNames": { "en-US": "Alcohol 1" }, "Descriptions": {}, "ParentProductCategory": [ { "Id": "0b82f6d8-e5eb-4711-9069-40db2b8d968f" }, { "Names": { "en-US": "Alcoholic beverages" } } ], "CreatedUtc": "2023-06-09T13:32:32Z", "UpdatedUtc": "2023-06-09T13:32:32Z", "Ordering": 1 }, { "Id": "f0709b02-f1a4-46b2-9c1e-744b5ecd6980", "ServiceId": "9b3a6c54-63aa-4383-b50e-b0030078184b", "Names": { "en-US": "Lemonade 1" }, "ShortNames": { "en-US": "Lemonade 1" }, "Descriptions": {}, "ParentProductCategory": [ { "Id": "aa4f3930-3f9d-4df7-9c6b-5aba5b2f6f7e" }, { "Names": { "en-US": "Lemonades" } } ], "CreatedUtc": "2023-06-09T13:32:32Z", "UpdatedUtc": "2023-06-09T13:32:32Z", "Ordering": 1 } ], "Cursor": "f0709b02-f1a4-46b2-9c1e-744b5ecd6980"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.