Mews Product categories API

openapi: 3.0.4
info:
  title: BookingEngineApi Account notes Product categories API
  version: v1
servers:
- url: https://api.mews.com
tags:
- name: Product categories
paths:
  /api/connector/v1/productCategories/getAll:
    post:
      tags:
      - Product categories
      summary: Get all product categories
      description: Returns all categories of products. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
      operationId: productCategories_getAll
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductCategoryFilterParameters'
            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:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductCategoryResult'
              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
        '400':
          description: 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).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '401':
          description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '403':
          description: 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.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '408':
          description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '204':
          description: Server has successfully fulfilled the request and there is no additional information to send back.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '429':
          description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
        '500':
          description: 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](https://github.com/MewsSystems/gitbook-connector-api).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectorApiExceptionResult'
components:
  schemas:
    ConnectorApiExceptionResult:
      title: ConnectorApiExceptionResult
      type: object
      properties:
        Message:
          type: string
          nullable: true
        RequestId:
          type: string
          nullable: true
        Details:
          nullable: true
      additionalProperties: false
      x-schema-id: ConnectorApiExceptionResult
    ProductCategoryFilterParameters:
      title: ProductCategoryFilterParameters
      required:
      - AccessToken
      - Client
      - ClientToken
      - Limitation
      - ServiceIds
      type: object
      properties:
        ClientToken:
          minLength: 1
          type: string
          description: Token identifying the client application.
        AccessToken:
          minLength: 1
          type: string
          description: Access token of the client application.
        Client:
          minLength: 1
          type: string
          description: Name and version of the client application.
        Limitation:
          allOf:
          - $ref: '#/components/schemas/Limitation'
          description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
        EnterpriseIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
          nullable: true
        ProductCategoryIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `ProductCategory`.
          nullable: true
        ServiceIds:
          maxItems: 1000
          minItems: 1
          type: array
          items:
            type: string
            format: uuid
          description: Unique identifiers of `Service` to which the product categories belong.
        UpdatedUtc:
          title: Time interval
          allOf:
          - $ref: '#/components/schemas/TimeFilterInterval'
          description: Interval in which the product categories were updated.
          nullable: true
          x-max-interval-in-months: 3
      additionalProperties: false
      x-schema-id: ProductCategoryFilterParameters
    TimeFilterInterval:
      title: Time interval
      type: object
      properties:
        StartUtc:
          type: string
          format: date-time
          nullable: true
        EndUtc:
          type: string
          format: date-time
          nullable: true
      additionalProperties: false
      description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)**  \r\n  If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n  \r\n  ```\r\n  CreatedUtc == StartUtc\r\n  ```\r\n  \r\n  This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)**  \r\n  If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n  \r\n  ```\r\n  StartUtc <= CreatedUtc < EndUtc\r\n  ```\r\n  \r\n  In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted."
      x-schema-id: TimeFilterInterval
    ProductCategory:
      title: Product category
      required:
      - CreatedUtc
      - Descriptions
      - EnterpriseId
      - Id
      - Names
      - Ordering
      - ServiceId
      - ShortNames
      - UpdatedUtc
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the product category.
          format: uuid
        EnterpriseId:
          type: string
          description: Unique identifier of the enterprise to which the product category belongs.
          format: uuid
        ServiceId:
          type: string
          description: Unique identifier of the `Service` of the resource category.
          format: uuid
        Names:
          title: Localized text
          type: object
          additionalProperties:
            type: string
          description: All translations of the name.
          x-schema-id: LocalizedStrings
        ShortNames:
          title: Localized text
          type: object
          additionalProperties:
            type: string
          description: All translations of the short name.
          x-schema-id: LocalizedStrings
        Descriptions:
          title: Localized text
          type: object
          additionalProperties:
            type: string
          description: All translations of the description.
          x-schema-id: LocalizedStrings
        ParentProductCategory:
          title: Parent product category
          allOf:
          - $ref: '#/components/schemas/ParentProductCategory'
          description: Parent product category, if set.
          nullable: true
        UpdatedUtc:
          minLength: 1
          type: string
          description: Date and time of the product category update in UTC timezone in ISO 8601 format.
          format: date-time
        CreatedUtc:
          minLength: 1
          type: string
          description: Date and time of the product category creation in UTC timezone in ISO 8601 format.
          format: date-time
        Ordering:
          type: integer
          description: Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed).
          format: int32
      additionalProperties: false
      x-schema-id: ProductCategory
    ProductCategoryResult:
      title: ProductCategoryResult
      required:
      - ProductCategories
      type: object
      properties:
        ProductCategories:
          maxItems: 1000
          type: array
          items:
            $ref: '#/components/schemas/ProductCategory'
          description: Product categories.
        Cursor:
          type: string
          description: 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.
          format: uuid
          nullable: true
      additionalProperties: false
      x-schema-id: ProductCategoryResult
    ParentProductCategory:
      title: Parent product category
      required:
      - Id
      - Names
      type: object
      properties:
        Id:
          type: string
          description: Unique identifier of the product category.
          format: uuid
        Names:
          title: Localized text
          type: object
          additionalProperties:
            type: string
          description: All translations of the name.
          x-schema-id: LocalizedStrings
      additionalProperties: false
      description: ''
      x-schema-id: ParentProductCategory
    Limitation:
      title: Limitation
      required:
      - Count
      type: object
      properties:
        Count:
          type: integer
          format: int32
        Cursor:
          type: string
          format: uuid
          nullable: true
      additionalProperties: false
      description: Limitation on the quantity of data returned.
      x-schema-id: Limitation