openapi: 3.0.1
info:
  contact:
    email: api@fulfillmenttools.com
    name: fulfillmenttools
    url: https://fulfillmenttools.com/
  description: >-
    This is the fulfillmenttools API documentation. Visit
    https://docs.fulfillmenttools.com/ for first steps.
  termsOfService: http://swagger.io/terms/
  title: fulfillmenttools
  version: VERSIONLESS
servers:
  - url: https://{tenant}.api.fulfillmenttools.com
    variables:
      tenant:
        default: your-tenant-name
paths:
  /api/articles:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search articles tenant-wide based on title or tenantArticleId
      operationId: getArticles
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - in: query
          name: searchTerm
          required: false
          schema:
            minLength: 1
            type: string
        - in: query
          name: locale
          required: false
          schema:
            $ref: '#/components/schemas/SupportedLocale'
        - in: query
          name: tenantArticleId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryArticlePaginatedResult'
          description: >-
            Articles search result according to the request. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List articles
      x-fft-permissions:
        - LISTING_READ
      tags:
        - Stocks (Inventory)
  /api/articles/{tenantArticleId}/forecasts:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        the forecast for a specific tenantArticleId
      operationId: getForecastsForArticle
      parameters:
        - in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
        - in: query
          name: period
          required: false
          schema:
            enum:
              - DAILY
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ArticleStockForecast'
                type: array
          description: >-
            Forecast for the specified tenantArticleId. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get article forecast
      x-fft-permissions:
        - LISTING_READ
      tags:
        - Stocks (Inventory)
      x-badges:
        - color: red
          label: ALPHA
  /api/articles/{tenantArticleId}/stockdistribution:
    get:
      deprecated: false
      description: >-
        Stock per Facility for a specific tenantArticleId, also includes the
        Tenant-Wide Summary
      operationId: getStockDistribution
      parameters:
        - in: path
          name: tenantArticleId
          required: true
          schema:
            example: MY_ARTICLE_ID
            minLength: 1
            type: string
        - explode: false
          in: query
          name: facilityServiceTypes
          required: false
          schema:
            items:
              enum:
                - SHIP_FROM_STORE
                - PICKUP
              type: string
            type: array
        - explode: false
          in: query
          name: facilityStatus
          required: false
          schema:
            items:
              enum:
                - ONLINE
                - SUSPENDED
                - OFFLINE
              type: string
            type: array
        - in: query
          name: facilityName
          required: false
          schema:
            minLength: 1
            type: string
        - explode: true
          in: query
          name: facilityIds
          required: false
          schema:
            items:
              type: string
            type: array
        - explode: true
          in: query
          name: facilityGroupRefs
          required: false
          schema:
            example:
              - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
              - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
            items:
              type: string
            maxItems: 1
            type: array
        - description: >-
            The channels to included under "channelAdjusted" in each summary and
            facility stock. Provide up to 50 channelRefs, specify "UNALLOCATED
            for unallocated stock."
          explode: true
          in: query
          name: channelRefs
          required: false
          schema:
            example:
              - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
              - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
            items:
              type: string
            maxItems: 50
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockDistribution'
          description: >-
            Stock distribution was loaded & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get article stock distribution
      x-fft-permissions:
        - STOCK_AVAILABILITIES_READ
      tags:
        - Stocks (Inventory)
  /api/audits:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getAudits
      parameters:
        - in: query
          name: size
          required: false
          schema:
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: entityRef
          required: false
          schema:
            type: string
        - explode: false
          in: query
          name: entityType
          required: false
          schema:
            enum:
              - PACK_JOB
              - PICK_JOB
              - PICK_RUN
              - HANDOVER_JOB
              - SHIPMENT
              - PARCEL
              - CUSTOM_SERVICE
              - SERVICE_JOB
              - LINKED_SERVICE_JOBS
              - ORDER
              - ROUTING_PLAN
              - FACILITY
              - FACILITY_GROUP
              - FACILITY_CARRIER_CONNECTION
              - FACILITY_CUSTOM_SERVICE
              - ROUTING_STRATEGY
              - STOW_JOB
            type: string
        - in: query
          name: trace
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditsResult'
          description: Paginated result containing the matching Audit entities
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List audits
      x-fft-permissions:
        - AUDIT_READ
      tags:
        - Audits (Core)
  /api/audits/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Audit
      operationId: searchAudit
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List audits (search)
      x-fft-permissions:
        - AUDIT_READ
      tags:
        - Audits (Core)
      x-badges:
        - color: red
          label: ALPHA
  /api/brands:
    get:
      description: ''
      operationId: getAllBrands
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedBrands'
          description: All brands on listings for this tenant
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List brands
      tags:
        - Processes (Core)
  /api/cancelationreasons:
    get:
      description: ''
      operationId: getCancelationReasons
      parameters:
        - description: All entities after given ID
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelationReasons'
          description: >-
            Cancellation reasons were found and you were allowed to access them.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cancellation reason not found.
      summary: List cancellation reasons
      tags:
        - Orders Configuration (DOMS)
    post:
      operationId: postCancelationReason
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelationReasonForCreation'
        description: Create new cancellation reason
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelationReason'
          description: >-
            The cancellation reason has been successfully created. The Location
            header includes the URL of the document.
        '303':
          description: >-
            The cancellation reason already exists. The location header contains
            the URL of the document.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See the response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create cancellation reason
      tags:
        - Orders Configuration (DOMS)
  /api/cancelationreasons/{cancelationReasonId}:
    delete:
      description: ''
      operationId: deleteCancelationReason
      parameters:
        - description: ID of the cancellation reason you intend to delete
          in: path
          name: cancelationReasonId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            The cancellation reason was found, and you have been granted
            permission to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cancellation reason not found
      summary: Delete cancellation reason
      tags:
        - Orders Configuration (DOMS)
    get:
      description: ''
      operationId: getCancelationReasonById
      parameters:
        - description: ID of the cancellation reason you wish to retrieve
          in: path
          name: cancelationReasonId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelationReason'
          description: >-
            Cancellation reason was found and you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cancellation reason not found
      summary: Get cancellation reason
      tags:
        - Orders Configuration (DOMS)
    put:
      description: ''
      operationId: putCancelationReason
      parameters:
        - description: ID of the cancellation reason you intend to modify
          in: path
          name: cancelationReasonId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelationReasonForModification'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelationReason'
          description: >-
            Cancellation reason was found and you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cancellation reason not found
      summary: Update cancellation reason
      tags:
        - Orders Configuration (DOMS)
  /api/carriers:
    get:
      deprecated: false
      description: List carriers
      operationId: getCarriers
      parameters:
        - in: query
          name: size
          required: false
          schema:
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedCarriers'
          description: The current list of available carriers
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List carriers
      x-fft-permissions:
        - CARRIER_READ
      tags:
        - Carriers (Operations)
    post:
      deprecated: false
      description: Create carrier
      operationId: addCarrier
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Carrier'
          description: >-
            The carrier was successfully created. The Location header contains
            the URL of the carrier.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create carrier
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers (Operations)
  /api/carriers/{carrierId}:
    get:
      deprecated: false
      description: Get carrier
      operationId: getCarrier
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Carrier'
          description: >-
            Carrier was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get carrier
      x-fft-permissions:
        - CARRIER_READ
      tags:
        - Carriers (Operations)
    patch:
      deprecated: false
      description: Update carrier
      operationId: patchCarrier
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierPatchActions'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Carrier'
          description: >-
            Carrier was found & patch-set has been applied. The patched entity
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update carrier
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers (Operations)
  /api/carriers/{carrierId}/configuration:
    get:
      deprecated: false
      description: >-
        Retrieves the configuration for a specific carrier by its ID. If no
        configuration exists, a default one is created and returned.
      operationId: getCarrierConfiguration
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
          description: >-
            Carrier Configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get carrier config
      x-fft-permissions:
        - CARRIER_READ
      tags:
        - Carriers Configuration (Operations)
    put:
      deprecated: false
      description: >-
        Updates the complete configuration for a specific carrier. This includes
        settings like return labels, weight adjustments, non-delivery days,
        country service mappings, and pick-up times.
      operationId: putCarrierConfiguration
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/CarrierConfiguration'
                - $ref: '#/components/schemas/GlsCarrierConfiguration'
                - $ref: '#/components/schemas/FedexCarrierConfiguration'
                - $ref: '#/components/schemas/BringCarrierConfiguration'
                - $ref: '#/components/schemas/DpdChCarrierConfiguration'
                - $ref: '#/components/schemas/DhlV2CarrierConfiguration'
                - $ref: '#/components/schemas/VceCarrierConfiguration'
                - $ref: '#/components/schemas/PostNlCarrierConfiguration'
                - $ref: '#/components/schemas/SevenSendersCarrierConfiguration'
                - $ref: '#/components/schemas/UBSendCarrierConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierConfiguration'
          description: >-
            Carrier Configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update carrier config
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers Configuration (Operations)
  /api/carriers/{carrierId}/configuration/countryservicemappings:
    get:
      deprecated: false
      description: List country service mappings
      operationId: getCarrierCountryServiceMappings
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CarrierCountryServiceMapping'
                type: array
          description: >-
            Carrier's countryservicemappings found & you are allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List country service mappings
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers Configuration (Operations)
    post:
      deprecated: false
      description: Create country service mapping
      operationId: createCarrierCountryServiceMapping
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCountryServiceMappingForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCountryServiceMapping'
          description: >-
            CarrierCountryServiceMapping successfully created. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create country service mapping
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers Configuration (Operations)
  /api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}:
    delete:
      deprecated: false
      description: Delete country service mapping
      operationId: deleteCarrierCountryServiceMapping
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
        - in: path
          name: countryServiceMappingId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: CarrierCountryServiceMapping successfully deleted.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete country service mapping
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers Configuration (Operations)
    get:
      deprecated: false
      description: Get country service mapping
      operationId: getCarrierCountryServiceMapping
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
        - in: path
          name: countryServiceMappingId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCountryServiceMapping'
          description: >-
            Carrier's countryservicemapping found & you are allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get country service mapping
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers Configuration (Operations)
    patch:
      deprecated: false
      description: Update country service mapping
      operationId: updateCarrierCountryServiceMapping
      parameters:
        - in: path
          name: carrierId
          required: true
          schema:
            type: string
        - in: path
          name: countryServiceMappingId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCountryServiceMappingForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierCountryServiceMapping'
          description: >-
            CarrierCountryServiceMapping successfully updated. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update country service mapping
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Carriers Configuration (Operations)
  /api/categories:
    get:
      deprecated: false
      description: ''
      operationId: getCategories
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Category'
                type: array
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List categories
      x-fft-permissions:
        - CATEGORY_READ
      tags:
        - Categories (Inventory)
    post:
      deprecated: false
      description: ''
      operationId: createCategory
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategoryForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create category
      x-fft-permissions:
        - CATEGORY_WRITE
      tags:
        - Categories (Inventory)
  /api/categories/{categoryId}:
    delete:
      deprecated: false
      description: ''
      operationId: deleteCategory
      parameters:
        - in: path
          name: categoryId
          required: true
          schema:
            type: string
        - in: query
          name: forceDeletion
          required: false
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Delete category
      x-fft-permissions:
        - CATEGORY_WRITE
      tags:
        - Categories (Inventory)
    get:
      deprecated: false
      description: ''
      operationId: getCategory
      parameters:
        - in: path
          name: categoryId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get category
      x-fft-permissions:
        - CATEGORY_READ
      tags:
        - Categories (Inventory)
    put:
      deprecated: false
      description: ''
      operationId: replaceCategory
      parameters:
        - in: path
          name: categoryId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategoryForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Category'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Replace category
      x-fft-permissions:
        - CATEGORY_WRITE
      tags:
        - Categories (Inventory)
  /api/categories/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Category
      operationId: searchCategory
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CategorySearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List categories (search)
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Categories (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/capacityplanningtimeframe:
    get:
      description: ''
      operationId: getCapacityPlanningTimeframeConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
          description: >-
            Configuration was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      summary: Get capacity planning timeframe
      tags:
        - Routing Plans Configuration (DOMS)
    put:
      description: ''
      operationId: putCapacityPlanningTimeframeConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
          description: Configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      summary: Update capacity planning timeframe
      tags:
        - Routing Plans Configuration (DOMS)
  /api/configurations/cutofftime:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getCutoffTimeConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CutoffTimeConfiguration'
          description: >-
            Cutoff time configuration was found & you were allowed to access it.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cutoff time configuration not found
      summary: Get cutoff time
      tags:
        - Picking Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: putCutoffTimeConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CutoffTimeConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CutoffTimeConfiguration'
          description: Cutoff time configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cutoff time configuration not found
      summary: Update cutoff time
      tags:
        - Picking Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/deliverynote:
    get:
      operationId: getDeliveryNoteConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryNoteConfiguration'
          description: >-
            Delivery note configuration was found & you were allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Delivery note configuration not found
      summary: Get delivery note config
      tags:
        - Shipments Configuration (Operations)
    put:
      operationId: putDeliveryNoteConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryNoteConfigurationForUpsert'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryNoteConfiguration'
          description: Delivery note configuration was successfully updated
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryNoteConfiguration'
          description: Delivery note configuration was successfully created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update delivery note config
      tags:
        - Shipments Configuration (Operations)
  /api/configurations/domain:
    get:
      description: Returns the authentication domain.
      operationId: getDomainConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainConfiguration'
          description: Domain config could be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get domain
      tags:
        - Artifacts (Infrastructure)
    put:
      description: Updates the authentication domain.
      operationId: putDomainConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainConfiguration'
        description: Desired domain note configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainConfiguration'
          description: The domain configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainConfiguration'
          description: The domain configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update domain
      tags:
        - Artifacts (Infrastructure)
  /api/configurations/eventscopes/inventoryarticleavailabilitychanged:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create a new event scope configuration for inventory article
        availability changed events.
      operationId: createEventScopeConfig
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/InventoryArticleAvailabilityChangedEventScopeForCreation
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/InventoryArticleAvailabilityChangedEventScope
          description: The created event scope configuration.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create event scope config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Event Scope Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/eventscopes/inventoryarticleavailabilitychanged/{id}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete an event scope configuration by ID or URN.
      operationId: deleteEventScopeConfig
      parameters:
        - description: >-
            ID of scope you want to get. Also accepts key in urn format (e.g.,
            urn:fft:eventScopeConfig:key:{your-key}).
          in: path
          name: id
          required: true
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/InventoryArticleAvailabilityChangedEventScope
          description: The event scope configuration was deleted.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete event scope config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Event Scope Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        an event scope configuration by ID or URN.
      operationId: getEventScopeConfig
      parameters:
        - description: >-
            ID of scope you want to get. Also accepts key in urn format (e.g.,
            urn:fft:eventScopeConfig:key:{your-key}).
          in: path
          name: id
          required: true
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/InventoryArticleAvailabilityChangedEventScope
          description: The event scope configuration.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get event scope config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Event Scope Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Replace an existing event scope configuration.
      operationId: replaceEventScopeConfig
      parameters:
        - description: >-
            ID of scope you want to get. Also accepts key in urn format (e.g.,
            urn:fft:eventScopeConfig:key:{your-key}).
          in: path
          name: id
          required: true
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/InventoryArticleAvailabilityChangedEventScopeForReplace
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/InventoryArticleAvailabilityChangedEventScope
          description: The updated event scope configuration.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Replace event scope config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Event Scope Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/eventscopes/inventoryarticleavailabilitychanged/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for ScopedAvailabilityConfig
      operationId: searchScopedAvailabilityConfig
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopedAvailabilityConfigSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedAvailabilityConfigPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List event scope configs (search)
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Event Scope Configuration (Core)
      x-badges:
        - color: red
          label: ALPHA
  /api/configurations/expiry:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getExpiryConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryConfiguration'
          description: config found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get expiry config
      tags:
        - Expiries Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: upsertExpiryConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpiryConfiguration'
        description: Desired configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryConfiguration'
          description: The configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryConfiguration'
          description: The configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update expiry config
      tags:
        - Expiries Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/fulfillmentprocessbuffer:
    get:
      description: ''
      operationId: getFulfillmentProcessBufferConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
          description: >-
            Configuration was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      summary: Get fulfillment process buffer
      tags:
        - Picking Configuration (Operations)
    put:
      description: ''
      operationId: putFulfillmentProcessBufferConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
          description: Configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      summary: Update fulfillment process buffer
      tags:
        - Picking Configuration (Operations)
  /api/configurations/gdpr:
    get:
      description: ''
      operationId: getGdprConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GdprConfiguration'
          description: >-
            Gdpr configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Gdpr configuration not found
      summary: Get GDPR config
      tags:
        - Configurations (Core)
    put:
      description: ''
      operationId: putGdprConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GdprConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GdprConfiguration'
          description: Gdpr configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Gdpr configuration not found
      summary: Update GDPR config
      tags:
        - Configurations (Core)
  /api/configurations/handover:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns the handover configuration for the tenant
      operationId: getHandoverConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverConfiguration'
          description: >-
            Handover configuration was found & you were allowed to access it.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get handover config
      tags:
        - Handovers Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Updates the handover configuration for the tenant. If the
        configuration does not exist, it will be created.
      operationId: upsertHandoverConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverConfigurationForCreate'
        description: Desired HandoverConfiguration
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverConfiguration'
          description: The handover configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update handover configuration
      tags:
        - Handovers Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/handover/refusereasons:
    get:
      description: ''
      operationId: getAllRefuseReasons
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AvailableRefusedReason'
                type: array
          description: Existing refuse reasons
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List refuse reasons
      tags:
        - Handovers Configuration (Operations)
  /api/configurations/inventory:
    get:
      deprecated: false
      description: ''
      operationId: getInventoryConfigurations
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryConfiguration'
          description: Requested Inventory Configuration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get inventory config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Stocks Configuration (Inventory)
    patch:
      deprecated: false
      description: ''
      operationId: upsertInventoryConfigurations
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryConfigurationForPatch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryConfiguration'
          description: Requested Inventory Configuration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update inventory config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Stocks Configuration (Inventory)
  /api/configurations/loadunit:
    get:
      operationId: getLoadUnitConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitConfiguration'
          description: The load unit configuration can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get load unit config
      tags:
        - Picking Configuration (Operations)
    put:
      description: ''
      operationId: putLoadUnitConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitConfiguration'
        description: Desired load unit configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitConfiguration'
          description: The load unit configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitConfiguration'
          description: The load unit configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update load unit config
      tags:
        - Picking Configuration (Operations)
  /api/configurations/locale:
    get:
      description: ''
      operationId: getLocaleConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocaleConfiguration'
          description: The locale Configuration can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get locale config
      tags:
        - Configurations (Core)
    put:
      description: ''
      operationId: putLocaleConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocaleConfiguration'
        description: Desired default locale configuration to put
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocaleConfiguration'
          description: The locale Configuration was successfully set.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update locale config
      tags:
        - Configurations (Core)
  /api/configurations/notifications:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns the notification center configuration.
      operationId: getNotificationCenterConfig
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: The notification center configuration was successfully returned.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get notification config
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_READ
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update the notification center configuration.
      operationId: upsertNotificationCenterConfig
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
                - allOf:
                    - $ref: '#/components/schemas/NotificationCenterConfigForCreation'
                  not:
                    required:
                      - version
                  type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: Notification center configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: Notification center configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update notification config
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_WRITE
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/notifications/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Executes an action to manipulate the notification center
        configuration.
      operationId: executeNotificationCenterConfigAction
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddChannelAction'
                - $ref: '#/components/schemas/UpdateChannelByIdAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: Notification center configuration action was successfully executed.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Call notification action
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_WRITE
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/notifications/channels/{channelId}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete the notification channel.
      operationId: deleteNotificationCenterConfigChannel
      parameters:
        - in: path
          name: channelId
          required: true
          schema:
            type: string
        - in: query
          name: version
          required: true
          schema:
            type: number
      responses:
        '200':
          description: Notification center config channel was successfully deleted.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Delete notification channel
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_WRITE
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/oidcproviders:
    get:
      deprecated: false
      description: Return a complete list of all configured OIDC providers.
      operationId: getOidcProviders
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviders'
          description: Existing oidc providers.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get OIDC providers
      x-fft-permissions:
        - OIDC_PROVIDERS_CONFIG_READ
      tags:
        - OIDC Configuration (Infrastructure)
    post:
      deprecated: false
      description: >-
        Registers an external OIDC provider so the platform can interact with it
        for user authentication.
      operationId: createOidcProvider
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderForCreation'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedOidcProvider'
          description: Provider was found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create OIDC provider
      x-fft-permissions:
        - OIDC_PROVIDERS_CONFIG_WRITE
      tags:
        - OIDC Configuration (Infrastructure)
  /api/configurations/oidcproviders/{oidcProviderId}:
    delete:
      deprecated: false
      description: >-
        Removes an OIDC provider configuration, disabling the platform’s ability
        to authenticate via that provider.
      operationId: deleteOidcProvider
      parameters:
        - in: path
          name: oidcProviderId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OIDC Provider was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete OIDC provider
      x-fft-permissions:
        - OIDC_PROVIDERS_CONFIG_WRITE
      tags:
        - OIDC Configuration (Infrastructure)
    get:
      deprecated: false
      description: Get the configuration of a configured OIDC provider.
      operationId: getOidcProvider
      parameters:
        - in: path
          name: oidcProviderId
          required: true
          schema:
            type: string
      responses:
        '201':
          description: The users was successfully created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get OIDC provider
      x-fft-permissions:
        - OIDC_PROVIDERS_CONFIG_READ
      tags:
        - OIDC Configuration (Infrastructure)
    patch:
      deprecated: false
      description: >-
        Change the configuration of an already configured OIDC provider. Only
        the specified values are changed.
      operationId: patchOidcProvider
      parameters:
        - in: path
          name: oidcProviderId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderForPatch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedOidcProvider'
          description: Provider was patched successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update OIDC provider
      x-fft-permissions:
        - OIDC_PROVIDERS_CONFIG_WRITE
      tags:
        - OIDC Configuration (Infrastructure)
    put:
      deprecated: false
      description: >-
        Change the configuration of an already configured OIDC provider. The
        configuration has to contain all necessary values.
      operationId: updateOidcProvider
      parameters:
        - in: path
          name: oidcProviderId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderForUpdate'
        required: true
      responses:
        '200':
          description: Provider was updated successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update OIDC provider
      x-fft-permissions:
        - OIDC_PROVIDERS_CONFIG_WRITE
      tags:
        - OIDC Configuration (Infrastructure)
  /api/configurations/operativerestowing:
    get:
      operationId: getOperationalRestowingConfigurations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationalRestowingConfigurations'
          description: Configuration of all restow item related things
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get restow config
      tags:
        - Restowing Configuration (Operations)
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      x-badges:
        - color: orange
          label: BETA
    patch:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: putOperationalRestowingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationalRestowingConfigurations'
        description: create/update operational restowing configurations
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationalRestowingConfigurations'
          description: The restowing configurations were successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationalRestowingConfigurations'
          description: The restowing configurations were successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update restow config
      tags:
        - Restowing Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/operativeservice:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        operative service config
      operationId: getOperativeServiceConfiguration
      parameters:
        - description: >-
            Provide the localized names and descriptions for operative service
            configuration. If not provided the default locale is used.
          in: query
          name: locale
          required: false
          schema:
            enum:
              - de_DE
              - en_US
              - pl_PL
              - ru_RU
              - nl_NL
              - fr_FR
              - it_IT
              - nb_NO
              - es_ES
              - cs_CZ
              - sk_SK
              - pt_PT
              - sl_SI
              - ro_RO
              - bg_BG
              - hr_HR
              - hu_HU
              - tr_TR
            example: en-US
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeServiceConfiguration'
          description: Central Configuration of all Service related operations
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get operative service config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Services Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create or update the operative service configuration.
      operationId: upsertOperativeServiceConfigurations
      parameters:
        - description: >-
            Provide the localized names and descriptions for the operative
            service configuration. If not provided the default locale is used.
          in: query
          name: locale
          required: false
          schema:
            enum:
              - de_DE
              - en_US
              - pl_PL
              - ru_RU
              - nl_NL
              - fr_FR
              - it_IT
              - nb_NO
              - es_ES
              - cs_CZ
              - sk_SK
              - pt_PT
              - sl_SI
              - ro_RO
              - bg_BG
              - hr_HR
              - hu_HU
              - tr_TR
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperativeServiceConfigurationForUpsert'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeServiceConfiguration'
          description: The operative service configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeServiceConfiguration'
          description: The operative service configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update operative service config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Services Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/ordercancelation:
    get:
      description: Get the order cancelation configuration.
      operationId: getOrderCancelationConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderCancelationConfiguration'
          description: The Order Cancelation Configuration can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get order cancelation config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Orders Configuration (DOMS)
    put:
      description: Update the order cancelation configuration.
      operationId: putOrderCancelationConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCancelationConfiguration'
        description: Desired order cancelation configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderCancelationConfiguration'
          description: The order cancelation configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderCancelationConfiguration'
          description: The order cancelation configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update order cancelation config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Orders Configuration (DOMS)
  /api/configurations/ordermodification:
    get:
      description: Get the order modification configuration.
      operationId: getOrderModificationConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderModificationConfiguration'
          description: The Order Modification Configuration can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get order modification config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Orders Configuration (DOMS)
    put:
      description: Update the order modification configuration.
      operationId: putOrderModificationConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderModificationConfiguration'
        description: Desired order modification configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderModificationConfiguration'
          description: The order modification configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderModificationConfiguration'
          description: The order modification configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update order modification config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Orders Configuration (DOMS)
  /api/configurations/orderrecords:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        the current configuration for the order records functionality
      operationId: getOrderRecordsConfiguration
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecordsConfiguration'
          description: The order records configuration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get order records configuration
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Order Records (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    put:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create or update the configuration for the order records
        functionality.
      operationId: updateOrderRecordsConfiguration
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRecordsConfigurationInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecordsConfiguration'
          description: The updated order records configuration
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecordsConfiguration'
          description: The created order records configuration
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create or update order records configuration
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Order Records (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/configurations/orderrouting:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getOrderRoutingConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRoutingConfiguration'
          description: The Order Routing Configuration can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get order routing config
      tags:
        - Routing Plans Configuration (DOMS)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: ''
      operationId: putOrderRoutingConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRoutingConfiguration'
        description: Desired order routing configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRoutingConfiguration'
          description: The order routing configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRoutingConfiguration'
          description: The order routing configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update order routing config
      tags:
        - Routing Plans Configuration (DOMS)
  /api/configurations/ordersources:
    get:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns available sources of orders.
      operationId: getOrderSourceConfiguration
      parameters:
        - description: All order sources after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Number of order sources to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            maximum: 500
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderSourceConfiguration'
          description: The Order Source Configuration can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get order source config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Orders Source (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    post:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create order sources.
      operationId: postOrderSourceConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderSourceEntryForCreation'
        description: Desired order source configuration to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderSourceEntry'
          description: The order source configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create order source config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Orders Source (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/configurations/ordersources/{ordersourceId}:
    delete:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete order source.
      operationId: deleteOrderSource
      parameters:
        - in: path
          name: ordersourceId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderSourceConfiguration'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: ''
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: ''
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Orders Source (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    put:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update order source.
      operationId: putOrderSource
      parameters:
        - in: path
          name: ordersourceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderSourceEntryForUpdate'
        description: Desired order source configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderSourceEntry'
          description: The order source was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update order source config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Orders Source (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/configurations/packing:
    get:
      operationId: getPackingConfigurations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingConfigurations'
          description: Central Configuration of all packing related things
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get packing config
      tags:
        - Packing Configuration (Operations)
    patch:
      description: ''
      operationId: upsertPackingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingConfigurations'
        description: create/update packing central configuration
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingConfigurations'
          description: The packing central configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingConfigurations'
          description: The packing central configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update packing config
      tags:
        - Packing Configuration (Operations)
  /api/configurations/packing/containerrequired:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, replaced with /api/configurations/packing
      operationId: getPackingContainerRequirement
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingContainerRequiredConfiguration'
          description: The requirement of containers in packing can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get packing container required config
      tags:
        - Packing Configuration (Operations)
    put:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, will be replaced with /api/configurations/packing
      operationId: putPackingContainerRequirement
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingContainerRequiredConfiguration'
        description: Validation picking scan code to activate/deactivate
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingContainerRequiredConfiguration'
          description: >-
            The packing container requirement configuration was successfully
            updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingContainerRequiredConfiguration'
          description: >-
            The packing container requirement configuration was successfully
            created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update packing container required config
      tags:
        - Packing Configuration (Operations)
  /api/configurations/picking:
    get:
      operationId: getPickingConfigurations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickingConfigurations'
          description: Central Configuration of all picking related things
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get picking config
      tags:
        - Picking Configuration (Operations)
    patch:
      description: ''
      operationId: putPickingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickingConfigurations'
        description: Update picking central configuration
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickingConfigurations'
          description: The picking central configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickingConfigurations'
          description: The picking central configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update picking config
      tags:
        - Picking Configuration (Operations)
  /api/configurations/pickingtimes:
    get:
      description: ''
      operationId: getDefaultPickingTimesConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultPickingTimesConfiguration'
          description: Picking Times config found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get picking times
      tags:
        - Picking Configuration (Operations)
    put:
      description: ''
      operationId: putDefaultPickingTimesConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultPickingTimesConfiguration'
        description: Desired default picking times configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultPickingTimesConfiguration'
          description: The default picking times configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Configuration version conflict
      summary: Update picking times
      tags:
        - Picking Configuration (Operations)
  /api/configurations/promises:
    get:
      description: ''
      operationId: getPromisesConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromisesConfiguration'
          description: >-
            Promises configuration was found & you were allowed to access it.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Promises configuration not found
      summary: List promises
      tags:
        - Orders Configuration (DOMS)
    put:
      description: ''
      operationId: putPromisesConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromisesConfiguration'
        description: Desired promises configuration to put
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromisesConfiguration'
          description: The promisesConfiguration was successfully put.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Change promises config
      tags:
        - Orders Configuration (DOMS)
  /api/configurations/return:
    get:
      deprecated: false
      description: Returns the current return configuration for the tenant.
      operationId: getReturnConfiguration
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalizedReturnConfiguration'
          description: Return Configuration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get return configuration
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Returns Configuration (Operations)
    put:
      deprecated: false
      description: >-
        Updates the return configuration for the tenant. If no configuration
        exists, it will be created.
      operationId: upsertReturnConfiguration
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalizedReturnConfiguration'
          description: ItemReturnJob containing the newly created item return
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalizedReturnConfiguration'
          description: ItemReturnJob containing the newly created item return
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Upsert return configuration
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Returns Configuration (Operations)
  /api/configurations/returnnote:
    get:
      operationId: getReturnNoteConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnNoteConfiguration'
          description: Return note config could be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get return note config
      tags:
        - Shipments Configuration (Operations)
    put:
      description: ''
      operationId: putReturnNoteConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnNoteConfigurationForUpsert'
        description: Desired return note configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnNoteConfiguration'
          description: The return note configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnNoteConfiguration'
          description: The return note configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update return note config
      tags:
        - Shipments Configuration (Operations)
  /api/configurations/shipping:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves the tenant-wide shipping configuration. A default
        configuration is created automatically on first access.
      operationId: getShippingConfiguration
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingConfiguration'
          description: Successfully retrieved the shipping configuration.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get the shipping configuration
      x-fft-permissions:
        - SHIPMENT_READ
      tags:
        - ShippingConfiguration (carrier)
      x-badges:
        - color: red
          label: ALPHA
    patch:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates or updates the tenant-wide shipping configuration. The version
        must match the currently persisted version.
      operationId: upsertShippingConfiguration
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingConfigurationForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingConfiguration'
          description: Successfully created or updated the shipping configuration.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create or update the shipping configuration
      x-fft-permissions:
        - SHIPMENT_READ
      tags:
        - ShippingConfiguration (carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/configurations/stock:
    get:
      description: Read current stock configuration
      operationId: getStockConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockConfiguration'
          description: StockConfiguration config found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get stock config
      tags:
        - Stocks Configuration (Inventory)
    put:
      description: Update stock configuration
      operationId: putStockConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockConfigurationForUpdate'
        description: Desired stock configuration to put
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockConfiguration'
          description: The stockConfiguration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update stock config
      tags:
        - Stocks Configuration (Inventory)
  /api/configurations/substitution:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getSubstitutionConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubstitutionConfiguration'
          description: Substitution config found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get substitution config
      tags:
        - Picking Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: ''
      operationId: putSubstitutionConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubstitutionConfiguration'
        description: Desired substitution configuration to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubstitutionConfiguration'
          description: The substitution configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubstitutionConfiguration'
          description: The substitution configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      summary: Update substitution config
      tags:
        - Picking Configuration (Operations)
  /api/configurations/supportedlocales:
    get:
      description: ''
      operationId: getLocales
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedLocales'
          description: The supported locales can be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List supported locales
      tags:
        - Configurations (Core)
  /api/configurations/tags/handoverjob:
    get:
      description: ''
      operationId: getHandoverJobTagConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverJobTagConfiguration'
          description: handoverJob tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get handover jobs tag config
      tags:
        - Handovers Configuration (Operations)
    put:
      description: ''
      operationId: putHandoverTagConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverJobTagConfiguration'
        description: Desired Tag Configuration for HandoverJobs
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverJobTagConfiguration'
          description: The handoverjob tag configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update handover jobs tag config
      tags:
        - Handovers Configuration (Operations)
  /api/configurations/tags/order:
    get:
      description: Get the order tag configuration.
      operationId: getOrderTagConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderTagConfiguration'
          description: order tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get order tag configuration
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Orders Configuration (DOMS)
    put:
      description: Update the order tag configuration.
      operationId: putOrderTagConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderTagConfiguration'
        description: Desired Tag Configuration for orders
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderTagConfiguration'
          description: The order tag configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update order tag configuration
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Orders Configuration (DOMS)
  /api/configurations/tags/packjob:
    get:
      description: ''
      operationId: getPackJobTagConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJobTagConfiguration'
          description: Packjob tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack jobs tag config
      tags:
        - Packing Configuration (Operations)
    put:
      description: ''
      operationId: putPackJobTagConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobTagConfiguration'
        description: Desired PackJobTagConfiguration
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJobTagConfiguration'
          description: The packing configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update pack jobs tag config
      tags:
        - Packing Configuration (Operations)
  /api/configurations/tags/parcel:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns the tag configuration for parcels
      operationId: getParcelTagConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelTagConfiguration'
          description: tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get parcel tag config
      tags:
        - Shipments Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Updates the tag configuration for parcels.
      operationId: putParcelTagConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelTagConfigurationForUpsert'
        description: Desired Tag Configuration for Parcels
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelTagConfiguration'
          description: The tag configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update parcel tag config
      tags:
        - Shipments Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/configurations/tags/pickjob:
    get:
      description: ''
      operationId: getPickJobTagConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJobTagConfiguration'
          description: pickjob tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pick job tag config
      tags:
        - Picking Configuration (Operations)
    put:
      description: ''
      operationId: putPickJobTagConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobTagConfiguration'
        description: Desired Tag Configuration for Pickjobs
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJobTagConfiguration'
          description: The packing configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update pick job tag config
      tags:
        - Picking Configuration (Operations)
  /api/configurations/tenant:
    get:
      description: ''
      operationId: getTenantConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantConfiguration'
          description: >-
            Tenant configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Tenant configuration not found
      summary: Get tenant config
      tags:
        - Configurations (Core)
    put:
      description: Upsert tenant configuration
      operationId: putTenantConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantConfigurationForUpsert'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantConfiguration'
          description: Tenant configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Tenant configuration not found
      summary: Update tenant config
      tags:
        - Configurations (Core)
  /api/configurations/tenantconnector:
    get:
      deprecated: false
      description: ''
      operationId: getTenantConnectorConfigurations
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantConnectorConfigurations'
          description: >-
            Configuration was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: configuration not found
      summary: Get tenant connector config
      tags:
        - Artifacts (Infrastructure)
  /api/configurations/transittime:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getTransitTimeConfiguration
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransitTimeConfiguration'
          description: >-
            Transit time configuration was found & you were allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Cutoff time configuration not found
      summary: Get transit time config
      tags:
        - Carriers Configuration (Operations)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: putTransitTimeConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransitTimeConfigurationForUpsert'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransitTimeConfiguration'
          description: Transit time configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Transit time configuration not found
      summary: Update transit time config
      tags:
        - Carriers (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/customservices:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />List
        custom services
      operationId: getCustomServices
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: tenantCustomServiceId to filter for
          in: query
          name: tenantCustomServiceId
          required: false
          schema:
            example: MY-CUSTOM-SERVICE-1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedCustomServices'
          description: Custom services can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List custom services
      x-fft-permissions:
        - CUSTOM_SERVICE_READ
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create custom service
      operationId: createCustomService
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomServiceForCreation'
        description: Desired custom service to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/customservices/{customServiceId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        custom service
      operationId: getCustomService
      parameters:
        - description: ID of custom service you want to get
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: Custom service can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_READ
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
    patch:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Apply a patch set or partial update to the custom service.
      operationId: patchCustomService
      parameters:
        - description: ID of custom service you want to patch
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/CustomServicePatchActions'
                - $ref: '#/components/schemas/CustomServiceForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: >-
            Custom service was found & patch-set has been applied. The patched
            custom service is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/customservices/{customServiceId}/additionalinformation:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create additional information on the custom service.
      operationId: createCustomServiceAdditionalInformation
      parameters:
        - description: ID of custom service you want to create additional information for
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdditionalInformationForCreation'
        description: Desired additional information to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: Added additional information to the custom service.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Create additional information
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/customservices/{customServiceId}/additionalinformation/{additionalInformationId}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete an additional information entry from the custom service.
      operationId: deleteAdditionalInfo
      parameters:
        - description: ID of custom service
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
        - description: ID of additional information you want to delete
          in: path
          name: additionalInformationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: >-
            The custom service was successfully updated. additional information
            was removed.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Delete additional information
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update an additional information entry on the custom service.
      operationId: updateCustomServiceAdditionalInformation
      parameters:
        - description: ID of custom service
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
        - description: ID of additional information you want to put
          in: path
          name: additionalInformationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdditionalInformationForCreation'
        description: additional information to update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: Updated the additional information on the custom service
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update additional information
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/deliverynotes:
    post:
      operationId: createDeliveryNote
      parameters:
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE
          in: query
          name: locale
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryNote'
        required: true
      responses:
        '201':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DeliveryNote'
          description: Successfully created the delivery note.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create delivery note
      tags:
        - Shipments (Operations)
  /api/documents/{documentId}/file:
    get:
      deprecated: false
      description: Download a file by its id
      operationId: downloadProcessDocument
      parameters:
        - in: path
          name: documentId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The document with given id
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get file
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Processes (Core)
  /api/documents/merge:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Merge and download documents passed by document id and document set
        into one pdf
      operationId: downloadMergedDocuments
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MergeDocumentsParameter'
        required: true
      responses:
        '200':
          description: The merged document
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Merge and download passed documents
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Processes (Core)
      x-badges:
        - color: red
          label: ALPHA
  /api/documentSet/{documentSetRef}:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, use /api/documentsets/{documentSetRef} instead
      operationId: getDocumentSetDeprecated
      parameters:
        - description: Reference to the entity you want to get
          in: path
          name: documentSetRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSet'
          description: Documents were found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get document set
      x-fft-permissions:
        - DOCUMENT_SET_READ
      tags:
        - Document Sets (Core)
  /api/documentSet/{documentSetRef}/documents:
    post:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, use /api/documentsets/{documentSetRef}/documents instead
      operationId: addDocumentDeprecated
      parameters:
        - description: Reference to the documentSet you want to add a file to
          in: path
          name: documentSetRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalPrintableDocumentForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Document was found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create document
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Document Sets (Core)
  /api/documentSet/{documentSetRef}/documents/{documentRef}:
    patch:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, use
        /api/documentsets/{documentSetRef}/documents/{documentRef} instead
      operationId: updateDocumentDeprecated
      parameters:
        - description: Reference to the documentSet you want to update
          in: path
          name: documentSetRef
          required: true
          schema:
            type: string
        - description: Reference to the single document you want to update
          in: path
          name: documentRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrintableDocumentForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Document was found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update document
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Document Sets (Core)
  /api/documentSet/{documentSetRef}/documents/{documentRef}/file:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: downloadDocumentDeprecated
      parameters:
        - description: Reference to the documentSet you want to download a file from
          in: path
          name: documentSetRef
          required: true
          schema:
            type: string
        - description: Reference to the single document you want to download
          in: path
          name: documentRef
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The document as a stream
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get file
      x-fft-permissions:
        - DOCUMENT_SET_READ
      tags:
        - Document Sets (Core)
    put:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, use
        /api/documentsets/{documentSetRef}/documents/{documentRef}/file instead
      operationId: addContentToDocumentDeprecated
      parameters:
        - description: Reference to the documentSet you want to update
          in: path
          name: documentSetRef
          required: true
          schema:
            type: string
        - description: Reference to the single document you want to update
          in: path
          name: documentRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDocumentContentForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Changed Document
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update file
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Document Sets (Core)
  /api/documentsets/{documentSetRef}:
    get:
      deprecated: false
      description: Get document set for given id
      operationId: getDocumentSet
      parameters:
        - in: path
          name: documentSetRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentSet'
          description: Documents were found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get document set
      x-fft-permissions:
        - DOCUMENT_SET_READ
      tags:
        - Document Sets (Core)
  /api/documentsets/{documentSetRef}/documents:
    post:
      deprecated: false
      description: add new document to document set
      operationId: addDocument
      parameters:
        - in: path
          name: documentSetRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalPrintableDocumentForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Document was found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create document
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Document Sets (Core)
  /api/documentsets/{documentSetRef}/documents/{documentRef}:
    patch:
      deprecated: false
      description: Update document of document set
      operationId: updateDocument
      parameters:
        - in: path
          name: documentSetRef
          required: true
          schema:
            type: string
        - in: path
          name: documentRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrintableDocumentForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Document was found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update document
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Document Sets (Core)
  /api/documentsets/{documentSetRef}/documents/{documentRef}/file:
    get:
      deprecated: false
      description: Download file of document set
      operationId: downloadDocument
      parameters:
        - in: path
          name: documentSetRef
          required: true
          schema:
            type: string
        - in: path
          name: documentRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: The document as a stream
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get file
      x-fft-permissions:
        - DOCUMENT_SET_READ
      tags:
        - Document Sets (Core)
    put:
      deprecated: false
      description: Add document content to document set
      operationId: addContentToDocument
      parameters:
        - in: path
          name: documentSetRef
          required: true
          schema:
            type: string
        - in: path
          name: documentRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDocumentContentForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Changed Document
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update file
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Document Sets (Core)
  /api/expiries:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getExpiries
      parameters:
        - description: Status to filter the results
          in: query
          name: status
          required: false
          schema:
            $ref: '#/components/schemas/ExpiryEntityStatus'
        - description: ProcessRef to filter the results
          in: query
          name: processRef
          required: false
          schema:
            type: string
        - description: >-
            StartDate to filter the results. Expiry Date of results is after or
            equals the given value
          in: query
          name: startDate
          required: false
          schema:
            example: 2020-02-03T08:45:51.525Z
            format: date-time
            type: string
        - description: >-
            EndDate to filter the results. Expiry Date of results is before or
            equals the given value
          in: query
          name: endDate
          required: false
          schema:
            type: string
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExpiryEntity'
                type: array
          description: found entities in the result.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get expiries
      tags:
        - Expiries (Core)
      x-badges:
        - color: orange
          label: BETA
    post:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: createExpiry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpiryEntityForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryEntity'
          description: created entity in the result.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create expiry
      tags:
        - Expiries (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/expiries/{expiryId}:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getExpiry
      parameters:
        - description: id for the searched entity
          in: path
          name: expiryId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryEntity'
          description: found entity in the result.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get expiry
      tags:
        - Expiries (Core)
      x-badges:
        - color: orange
          label: BETA
    patch:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: updateExpiry
      parameters:
        - description: id of the entity to be changed
          in: path
          name: expiryId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpiryEntityForUpdate'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryEntity'
          description: changed entity in the result.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update expiry
      tags:
        - Expiries (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/externalactions:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns a list with all external actions.
      operationId: getExternalActions
      parameters:
        - description: all entities after given Id.
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: Filter by the given group or groups
          explode: true
          in: query
          name: groups
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Filter by the given processRef
          in: query
          name: processRef
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalAction'
                type: array
          description: Returning the list of external actions available.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: External action not found
      summary: List external actions
      tags:
        - External Actions (Core)
      x-badges:
        - color: orange
          label: BETA
    post:
      description: Creates a new external action for a process.
      operationId: postExternalAction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalActionForCreation'
        description: The external action to be created
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAction'
          description: The external action was successfully created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: External action not found
      summary: Create external action
      tags:
        - External Actions (Core)
  /api/externalactions/{externalActionId}:
    delete:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: deleteExternalAction
      parameters:
        - description: ID of the external action that you want delete
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: External action was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: External action not found
      summary: Delete external action
      tags:
        - External Actions (Core)
      x-badges:
        - color: orange
          label: BETA
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns an external action with the given id if found.
      operationId: getExternalAction
      parameters:
        - description: Id of the external action you want to get
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalAction'
                type: array
          description: >-
            External action was found & you are allowed to get it. The result is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: External action not found
      summary: Get external action
      tags:
        - External Actions (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Replaces the external action with the provided in the body.
      operationId: putExternalAction
      parameters:
        - description: ID of the external action that you want update
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalActionForReplacement'
        description: Update external action
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalAction'
          description: External action was found & you are allowed to update it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Replace an external action
      tags:
        - External Actions (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/externalactions/{externalActionId}/logs:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns the logs related with the given external action.
      operationId: getExternalActionLogs
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: Id of the external action you want to get the logs from
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ExternalActionLogs'
                type: array
          description: >-
            Logs were found & you are allowed to get it. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: External action logs not found
      summary: List external action logs
      tags:
        - External Actions (Core)
      x-badges:
        - color: orange
          label: BETA
    post:
      description: Creates a new external action log.
      operationId: postExternalActionLog
      parameters:
        - description: ID of the external action you want to create the log for
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalActionLogForCreation'
        description: The external action log to be created
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalActionLog'
          description: The log for the external action was successfully created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: External action not found
      summary: Create external action logs
      tags:
        - External Actions (Core)
  /api/externalstockchangereasons:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        external stock change reasons
      operationId: getExternalStockChangeReasons
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalStockChangeReason'
          description: List of external stock change reasons
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List stock change reasons
      x-fft-permissions:
        - EXTERNAL_STOCK_CHANGE_REASONS_READ
      tags:
        - Stocks Configuration (Inventory)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Post
        external stock change reason.
      operationId: postExternalStockChangeReason
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalStockChangeReasonForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalStockChangeReason'
          description: The created external stock change reason
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create stock change reason
      x-fft-permissions:
        - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
      tags:
        - Stocks Configuration (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/externalstockchangereasons/{externalStockChangeReasonId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        external stock change reason.
      operationId: getExternalStockChangeReason
      parameters:
        - in: path
          name: externalStockChangeReasonId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalStockChangeReason'
          description: The external stock change reason
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get stock change reason
      x-fft-permissions:
        - EXTERNAL_STOCK_CHANGE_REASONS_READ
      tags:
        - Stocks Configuration (Inventory)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update external stock change reason.
      operationId: putExternalStockChangeReason
      parameters:
        - in: path
          name: externalStockChangeReasonId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalStockChangeReasonForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalStockChangeReason'
          description: The updated external stock change reason
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update stock change reason
      x-fft-permissions:
        - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
      tags:
        - Stocks Configuration (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/facilities:
    get:
      description: ''
      operationId: getAllFacilities
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Reference to the status you want to get the corresponding facilities
          explode: true
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: number of facilities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: query facilities with the given tenantFacilityId
          in: query
          name: tenantFacilityId
          required: false
          schema:
            type: string
        - description: query facilities orderBy
          in: query
          name: orderBy
          required: false
          schema:
            $ref: '#/components/schemas/FacilityOrderBy'
        - description: Filters the facilities by type
          explode: true
          in: query
          name: type
          required: false
          schema:
            items:
              $ref: '#/components/schemas/FacilityType'
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedFacilities'
          description: Facilities are found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List facilities
      tags:
        - Facilities (Core)
    post:
      description: ''
      operationId: addFacility
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/ManagedFacilityForCreation'
                - $ref: '#/components/schemas/SupplierForCreation'
        description: Representation that describes the facility
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ManagedFacility'
                  - $ref: '#/components/schemas/Supplier'
          description: >-
            The facility was successfully created. The Location header contains
            the URL of the facility.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create facility
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}:
    delete:
      description: ''
      operationId: deleteFacility
      parameters:
        - description: >-
            ID of facility you want to delete. Also accepts tenantFacilityId in
            urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: cascading deletion without pre condition check
          in: query
          name: forceDeletion
          required: false
          schema:
            default: false
            type: boolean
      responses:
        '200':
          description: Facility was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Delete facility
      tags:
        - Facilities (Core)
    get:
      description: ''
      operationId: getFacility
      parameters:
        - description: >-
            ID of facility you want to get. Also accepts tenantFacilityId in urn
            format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ManagedFacility'
                  - $ref: '#/components/schemas/Supplier'
          description: >-
            Facility was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Get facility
      tags:
        - Facilities (Core)
    patch:
      description: ''
      operationId: patchFacility
      parameters:
        - description: >-
            ID of facility you want to patch. Also accepts tenantFacilityId in
            urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/FacilityPatchActions'
                - $ref: '#/components/schemas/ManagedFacilityForModification'
                - $ref: '#/components/schemas/SupplierForModification'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ManagedFacility'
                  - $ref: '#/components/schemas/Supplier'
          description: >-
            Facility was found & patch-set has been applied. The patched
            facility is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      summary: Update facility
      tags:
        - Facilities (Core)
    put:
      operationId: replaceFacility
      parameters:
        - description: >-
            ID of facility you want to replace. Also accepts tenantFacilityId in
            urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/ManagedFacilityForReplacement'
                - $ref: '#/components/schemas/SupplierForReplacement'
              discriminator:
                propertyName: type
                mapping:
                  MANAGED_FACILITY: '#/components/schemas/ManagedFacilityForReplacement'
                  SUPPLIER: '#/components/schemas/SupplierForReplacement'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ManagedFacility'
                  - $ref: '#/components/schemas/Supplier'
          description: Facility was replaced. The replaced facility is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      summary: Update facility
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/actions:
    post:
      operationId: facilityAction
      parameters:
        - description: >-
            Reference to the facility you want to call the action for. Also
            accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedFacility'
          description: Updated Facility in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call facility action
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/carriers:
    get:
      deprecated: false
      description: List all carrier connections configured for the given facility
      operationId: listFacilityCarriers
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedCarriers'
          description: Facility Carrier Connection List returned successfully.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List facility carrier connections
      x-fft-permissions:
        - FACILITY_READ
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/carriers/{carrierRef}:
    get:
      deprecated: false
      description: Get the details for a carrier related to the facility with the given ID
      operationId: getFacilityCarrier
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
        - in: path
          name: carrierRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCarrierConnection'
          description: >-
            Carrier to facility connections was found & you were allowed to
            access it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get facility carrier connection
      x-fft-permissions:
        - FACILITY_READ
      tags:
        - Facilities (Core)
    post:
      deprecated: false
      description: >-
        Create a connection of a configured carrier to the facility with given
        ID
      operationId: createCarrierToFacility
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
        - in: path
          name: carrierRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCarrierConnectionForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCarrierConnection'
          description: Creation was successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create facility carrier connection
      x-fft-permissions:
        - FACILITY_WRITE
      tags:
        - Facilities (Core)
    put:
      deprecated: false
      description: Connect a configured carrier to the facility with given ID
      operationId: connectCarrierToFacility
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
        - in: path
          name: carrierRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCarrierConnectionForModification'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCarrierConnection'
          description: Modification was successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update facility carrier connection
      x-fft-permissions:
        - FACILITY_WRITE
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/carriers/prioritization:
    post:
      deprecated: false
      description: >-
        Calculate prioritized list of recommended carriers for the given
        facility and input parameters
      operationId: calculateBestCarrier
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierPriorityCalculationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierPriorityResult'
          description: Calculated carrier prioritization result.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Calculate best carriers
      x-fft-permissions:
        - CARRIER_WRITE
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/configurations/inventory:
    get:
      deprecated: false
      description: Get the Inventory Configuration for a specific Facility.
      operationId: getInventoryFacilityConfigurations
      parameters:
        - description: >-
            ID of the facility you want to get the config for. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}) for the
            path parameter facilityId.
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryFacilityConfiguration'
          description: Requested Inventory Facility Configuration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get facility inventory config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Stocks Configuration (Inventory)
    patch:
      deprecated: false
      description: >-
        This endpoint allows you to update the inventory configuration for a
        specific facility. It is used to set or modify the inventory management
        settings at the facility level.
      operationId: upsertInventoryFacilityConfigurations
      parameters:
        - description: >-
            ID of the facility you want to set the config to. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}) for the
            path parameter facilityId.
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryFacilityConfigurationForPatch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryFacilityConfiguration'
          description: Requested Inventory Facility Configuration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update facility inventory config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Stocks Configuration (Inventory)
  /api/facilities/{facilityId}/configurations/stock:
    get:
      deprecated: false
      description: Get the stock configuration for a specific facility.
      operationId: getFacilityStockConfiguration
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityStockConfiguration'
          description: Configuration for stock routing was found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get facility stock config
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Stocks Configuration (Inventory)
    patch:
      deprecated: false
      description: Update the stock configuration for a specific facility.
      operationId: patchFacilityConfiguration
      parameters:
        - in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityStockConfiguration'
          description: >-
            Facility was found & patch-set has been applied. The patched
            facility configuration is in the body.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update facility stock config
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Stocks Configuration (Inventory)
  /api/facilities/{facilityId}/connections:
    get:
      description: >-
        Get the details for all connections related to the facility with the
        given ID.
      operationId: getFacilityConnections
      parameters:
        - description: ID of facility you want to get connections
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: The targetFacilityRef of the connection
          in: query
          name: targetFacilityRef
          required: false
          schema:
            type: string
        - description: all entities
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: >-
            Provide the localized names and descriptions for the parcel label
            classifications. If not provided the default locale is used., for
            example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterFacilityConnections'
          description: >-
            Facility connections was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List facility connections
      tags:
        - Facilities (Core)
    post:
      description: Create a connections for a supplier facility with given ID.
      operationId: createConnectionToFacility
      parameters:
        - description: ID of facility you want to create a connection for
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/InterFacilityConnectionToSupplierForCreation
                - $ref: >-
                    #/components/schemas/InterFacilityConnectionToManagedFacilityForCreation
                - $ref: >-
                    #/components/schemas/InterFacilityConnectionToCustomerForCreation
              discriminator:
                propertyName: type
                mapping:
                  CUSTOMER: >-
                    #/components/schemas/InterFacilityConnectionToCustomerForCreation
                  MANAGED_FACILITY: >-
                    #/components/schemas/InterFacilityConnectionToManagedFacilityForCreation
                  SUPPLIER: >-
                    #/components/schemas/InterFacilityConnectionToSupplierForCreation
        description: Representation that the connection
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterFacilityConnection'
          description: Creation was successful.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create facility connection
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/connections/{connectionId}:
    delete:
      description: Delete the connection for facility with the given ID
      operationId: deleteFacilityConnection
      parameters:
        - description: ID of facility you want to delete a connection
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: The ID of the connection you want to delete
          in: path
          name: connectionId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Deletion was successful
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: There is no connection for the facility and the provided id
      summary: Delete facility connection
      tags:
        - Facilities (Core)
    get:
      description: >-
        Get the details for a facility connection related to the facility with
        the given ID.
      operationId: getFacilityConnection
      parameters:
        - description: ID of facility you want to get connections
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: >-
            The ID that describes the connection of this facility to the its
            connections
          in: path
          name: connectionId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the parcel label
            classifications. If not provided the default locale is used., for
            example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterFacilityConnection'
          description: >-
            Facility connections was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            There is no connection for this facility referenced by the provided
            connectionId
      summary: Get facility connection
      tags:
        - Facilities (Core)
    put:
      description: Update the given connection for a facility
      operationId: updateFacilityConnection
      parameters:
        - description: ID of facility you want to get
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: The referenced connection ID
          in: path
          name: connectionId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the parcel label
            classifications. If not provided the default locale is used., for
            example de_DE.
          in: query
          name: locale
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/InterFacilityConnectionToSupplierForUpdate
                - $ref: >-
                    #/components/schemas/InterFacilityConnectionToManagedFacilityForUpdate
                - $ref: >-
                    #/components/schemas/InterFacilityConnectionToCustomerForUpdate
              discriminator:
                propertyName: type
                mapping:
                  CUSTOMER: >-
                    #/components/schemas/InterFacilityConnectionToCustomerForUpdate
                  MANAGED_FACILITY: >-
                    #/components/schemas/InterFacilityConnectionToManagedFacilityForUpdate
                  SUPPLIER: >-
                    #/components/schemas/InterFacilityConnectionToSupplierForUpdate
        description: Representation that describes the facility
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterFacilityConnection'
          description: Modification was successful.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            There is no connection with this facility referenced by the provided
            cnnectionId.
      summary: Update facility connection
      tags:
        - Facilities (Core)
  /api/facilities/{facilityId}/customservices:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />List
        facility custom service connections
      operationId: getFacilityCustomServiceConnections
      parameters:
        - description: >-
            ID of facility. Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
            minLength: 1
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedFacilityCustomServiceConnections'
          description: Facility custom service connections can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List facility custom services
      x-fft-permissions:
        - CUSTOM_SERVICE_READ
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/facilities/{facilityId}/customservices/{customServiceId}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete a facility custom service connection
      operationId: deleteFacilityCustomServiceConnection
      parameters:
        - description: >-
            ID of facility. Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of the custom service
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The facility custom service connection was successfully deleted.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete facility custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        a facility custom service connection
      operationId: getFacilityCustomService
      parameters:
        - description: >-
            ID of facility. Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of the custom service
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCustomServiceConnection'
          description: Facility custom service connection can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get facility custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_READ
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
    patch:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update an existing facility custom service connection
      operationId: updateFacilityCustomServiceConnection
      parameters:
        - description: >-
            ID of facility. Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of the custom service
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCustomServiceConnectionForUpdate'
        description: Desired custom service connection to create/update
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCustomServiceConnection'
          description: The facility custom service connection was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update facility custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create a new facility custom service connection
      operationId: createFacilityCustomServiceConnection
      parameters:
        - description: >-
            ID of facility. Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of the custom service
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCustomServiceConnectionForCreation'
        description: Desired custom service connection to create/update
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCustomServiceConnection'
          description: The facility custom service connection was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create facility custom service
      x-fft-permissions:
        - CUSTOM_SERVICE_WRITE
      tags:
        - Custom Services (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/facilities/{facilityId}/listings:
    delete:
      description: ''
      operationId: deleteListingsOfFacility
      parameters:
        - description: >-
            ID of facility you want to delete all listings of. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facility listings were found and successfully deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Delete listings
      tags:
        - Listings (Core)
    get:
      description: ''
      operationId: getFacilityListing
      parameters:
        - description: >-
            ID of facility you want to get listing for. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of facilities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: Array of tenantArticleIds
          explode: false
          in: query
          name: tenantArticleIds
          required: false
          schema:
            items:
              type: string
            maxItems: 500
            type: array
        - description: limit results to this scannableCode
          in: query
          name: scannableCode
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedListings'
          description: >-
            Facility was found & you were allowed to access it. The results are
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: List listings
      tags:
        - Listings (Core)
    put:
      description: >-
        Bulk PUT for Listings. Please note: This endpoint has legacy behaviour,
        i.e. all PUTs fail if a single PUT fails.
      operationId: putFacilityListing
      parameters:
        - description: >-
            ID of facility you want to put listings for. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingsForReplacement'
        description: listings for put
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ListingBulkOperationResult'
                type: array
          description: >-
            Facility listing was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Create and update listings per facility
      tags:
        - Listings (Core)
  /api/facilities/{facilityId}/listings/{tenantArticleId}:
    delete:
      description: ''
      operationId: deleteFacilityListing
      parameters:
        - description: >-
            ID of facility you want to delete a listing of. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: tenant ID of the articles listing you want to delete
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facility listing was found and successfully deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Delete listing
      tags:
        - Listings (Core)
    get:
      description: ''
      operationId: getListing
      parameters:
        - description: >-
            ID of facility you want to get listing. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: tenantArticleId of listing you want to get
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the listing. If not
            provided the default locale is used., for example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Listing'
          description: >-
            Listing is found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Listings not found
      summary: Get listing
      tags:
        - Listings (Core)
    patch:
      description: ''
      operationId: patchFacilityListing
      parameters:
        - description: >-
            ID of facility you want to patch a listing of. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: tenant ID of the articles listing you want to patch
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingPatchActions'
        description: listings for put
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Listing'
                type: array
          description: Facility listing was found and successfully patched
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Listing version conflict
      summary: Update listing
      tags:
        - Listings (Core)
  /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks:
    delete:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        endpoint is deprecated. Use /api/stocks endpoints instead.
      operationId: deleteFacilityListingPartialStock
      parameters:
        - description: >-
            ID of facility from whom you want to delete the partial stock. Also
            accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of listing you want to get partial stocks
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            Facility listing was found & you were allowed to delete the partial
            stock.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Delete listing partial stocks
      tags:
        - Listings (Core)
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        endpoint is deprecated. Use /api/stocks endpoints instead.
      operationId: getFacilityListingPartialStock
      parameters:
        - description: >-
            ID of facility you want to get the partial stocks. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of listing you want to get partial stocks
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PartialStock'
                type: array
          description: >-
            Facility and listing were found & you are allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or Listing not found
      summary: List listing partial stocks
      tags:
        - Listings (Core)
    patch:
      deprecated: true
      description: >
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        endpoint is deprecated. Use /api/stocks endpoints instead.

        Adds new partial stocks, updates existing partial stocks and keeps
        stocks that are previously present in the database.


        1. If a stock exists in the patch action but not in the database it is
        added.

        2. If a stock exists both in the patch action and in the database it is
        updated and the contents are merged.

        3. If a stock exists only in the database, it is left untouched.
      operationId: patchFacilityListingPartialStock
      parameters:
        - description: >-
            ID of facility you want to patch the partial stocks. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of listing you want to get partial stocks
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartialStockPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          description: Facility listing was found & you were allowed to update it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Update listing partial stocks
      tags:
        - Listings (Core)
    put:
      deprecated: true
      description: >
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        endpoint is deprecated. Use /api/stocks endpoints instead.

        Replaces the current partial stock object related to its listing
      operationId: putFacilityListingPartialStock
      parameters:
        - description: >-
            ID of facility you want to get listing. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of listing you want to get partial stocks
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartialStocksForReplacement'
        description: Patch set
        required: true
      responses:
        '200':
          description: Facility listing was found & you were allowed to update it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Update listing partial stocks
      tags:
        - Listings (Core)
  /api/facilities/{facilityId}/storagelocations:
    get:
      description: ''
      operationId: getFacilityStorageLocations
      parameters:
        - description: >-
            ID of facility from which you want to get the storage locations.
            Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: limit result to storage locations with scannable code
          in: query
          name: scannableCode
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StorageLocation'
                type: array
          description: >-
            Facility was found & you are allowed to get the storage locations.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: List facility storage locations
      tags:
        - Storage Locations (Inventory)
    post:
      description: Creates a new storage location in this facility.
      operationId: postFacilityStorageLocations
      parameters:
        - description: ID of facility from whom you want to create the storage location
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationForCreation'
        description: Patch set
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageLocation'
          description: The storage location was successfully created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Create facility storage location
      tags:
        - Storage Locations (Inventory)
  /api/facilities/{facilityId}/storagelocations/{storageLocationId}:
    delete:
      description: ''
      operationId: deleteFacilityStorageLocation
      parameters:
        - description: ID of facility from whom you want to delete the storage location
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of the storageLocation you want to delete
          in: path
          name: storageLocationId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Storage location was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or storage location not found
      summary: Delete facility storage location
      tags:
        - Storage Locations (Inventory)
    get:
      description: ''
      operationId: getFacilityStorageLocation
      parameters:
        - description: >-
            ID of facility from which you want to get the storage locations.
            Also accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: the ID of the storageLocation
          in: path
          name: storageLocationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StorageLocation'
                type: array
          description: >-
            Facility was found & you are allowed to get the storage locations.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Get facility storage location
      tags:
        - Storage Locations (Inventory)
    patch:
      description: >
        Adds new storage locations, updates existing ones and keeps the
        previously present ones in the database.


        1. If a storage location exists in the patch action but not in the
        database it is added.

        2. If a storage location exists both in the patch action and in the
        database it is updated and the contents merged.

        3. If a storage location exists only in the database, it is left
        untouched.
      operationId: patchFacilityStorageLocation
      parameters:
        - description: ID of facility you want to patch the storage locations
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: the ID of the storageLocation
          in: path
          name: storageLocationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageLocation'
          description: Storage location was found & you were allowed to update it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or Storage location not found
      summary: Update facility storage location
      tags:
        - Storage Locations (Inventory)
    put:
      description: >-
        Replaces the current storage locations of this Facility with the
        provided in the body.
      operationId: putFacilityStorageLocation
      parameters:
        - description: ID of facility from whom you want to put the storage locations
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: the ID of the storageLocation
          in: path
          name: storageLocationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationForReplacement'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageLocation'
          description: Storage location was found & you were allowed to update it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or Storage Location not found
      summary: Update facility storage location
      tags:
        - Storage Locations (Inventory)
  /api/facilities/{facilityId}/zones:
    get:
      description: ''
      operationId: getFacilityZones
      parameters:
        - description: >-
            ID of facility from which you want to get the zones. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Zone'
                type: array
          description: >-
            Facility was found & you are allowed to get the zones. The result is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: List facility zones
      tags:
        - Storage Locations (Inventory)
    post:
      description: Creates a new zone in this facility.
      operationId: postFacilityZone
      parameters:
        - description: >-
            ID of facility at which you want to create the zones. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoneForCreation'
        description: The zone to be created
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Zone'
          description: The zone was successfully created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Zone not found
      summary: Create facility zone
      tags:
        - Storage Locations (Inventory)
  /api/facilities/{facilityId}/zones/{zoneId}:
    delete:
      description: ''
      operationId: deleteFacilityZone
      parameters:
        - description: >-
            ID of facility from which you want to delete the zone. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: ID of the zone you want to delete
          in: path
          name: zoneId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Zone was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or storage location not found
      summary: Delete facility zone
      tags:
        - Storage Locations (Inventory)
    get:
      description: ''
      operationId: getFacilityZone
      parameters:
        - description: >-
            ID of facility from which you want to get the zone. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: the ID of the zone
          in: path
          name: zoneId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Zone'
                type: array
          description: >-
            Zone was found & you are allowed to get it. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Get facility zone
      tags:
        - Storage Locations (Inventory)
    put:
      description: >-
        Replaces the current zone of this Facility with the provided in the
        body.
      operationId: putFacilityZone
      parameters:
        - description: >-
            ID of facility from which you want to put the zone. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: the ID of the zone
          in: path
          name: zoneId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoneForReplacement'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Zone'
          description: Zone was found & you are allowed to update it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Update facility zone
      tags:
        - Storage Locations (Inventory)
  /api/facilities/{facilityRef}/configurations/notifications:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns the notification center facility configuration.
      operationId: getNotificationCenterFacilityConfig
      parameters:
        - in: path
          name: facilityRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: >-
            The notification center facility configuration was successfully
            returned.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get facility notification config
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_READ
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update the notification center facility configuration.
      operationId: upsertNotificationCenterFacilityConfig
      parameters:
        - in: path
          name: facilityRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
                - allOf:
                    - $ref: '#/components/schemas/NotificationCenterConfigForCreation'
                  not:
                    required:
                      - version
                  type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: Notification center facility configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: Notification center facility configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update facility notification config
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_WRITE
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/facilities/{facilityRef}/configurations/notifications/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Executes an action to manipulate the notification center facility
        configuration.
      operationId: executeNotificationCenterFacilityConfigAction
      parameters:
        - in: path
          name: facilityRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddChannelAction'
                - $ref: '#/components/schemas/UpdateChannelByIdAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
          description: >-
            Notification center facility configuration action was successfully
            executed.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Call facility notification action
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_WRITE
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete the notification facility channel.
      operationId: deleteNotificationCenterFacilityConfigChannel
      parameters:
        - in: path
          name: facilityRef
          required: true
          schema:
            type: string
        - in: path
          name: channelId
          required: true
          schema:
            type: string
        - in: query
          name: version
          required: true
          schema:
            type: number
      responses:
        '200':
          description: >-
            Notification center facility config channel was successfully
            deleted.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Delete facility notification channel
      x-fft-permissions:
        - NOTIFICATION_CENTER_CONFIG_WRITE
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/facilities/{facilityRef}/discounts:
    get:
      description: ''
      operationId: getDiscountsForFacility
      parameters:
        - description: >-
            ID of the facility you want to get the discounts for. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityRef
          required: true
          schema:
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of facilities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FacilityDiscountPaginatedResult'
          description: >-
            The discounts were successfully retrieved. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: List facility discounts
      tags:
        - Facilities (Core)
    post:
      description: ''
      operationId: addDiscountToFacility
      parameters:
        - description: >-
            ID of the facility you want to add the discount to. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityDiscountForCreation'
        description: Representation that describes the discount
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityDiscount'
          description: >-
            The discount was successfully created. The Location header contains
            the URL of the discount.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Create facility discount
      tags:
        - Facilities (Core)
  /api/facilities/{facilityRef}/discounts/{facilityDiscountRef}:
    delete:
      description: ''
      operationId: deleteDiscountForFacility
      parameters:
        - description: >-
            ID of the facility you want to delete the discount from. Also
            accepts tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityRef
          required: true
          schema:
            type: string
        - description: ID of the discount you want to delete
          in: path
          name: facilityDiscountRef
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The discount was successfully deleted. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or discount not found
      summary: Delete facility discount
      tags:
        - Facilities (Core)
    get:
      description: ''
      operationId: getDiscountForFacility
      parameters:
        - description: >-
            ID of the facility you want to get the discount for. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityRef
          required: true
          schema:
            type: string
        - description: ID of the discount you want to get
          in: path
          name: facilityDiscountRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityDiscount'
          description: The discount was successfully retrieved. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or discount not found
      summary: Get facility discount
      tags:
        - Facilities (Core)
    patch:
      description: ''
      operationId: updateDiscountForFacility
      parameters:
        - description: >-
            ID of the facility you want to update the discount for. Also accepts
            tenantFacilityId in urn format (e.g.
            urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
          in: path
          name: facilityRef
          required: true
          schema:
            type: string
        - description: ID of the discount you want to update
          in: path
          name: facilityDiscountRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityDiscountForUpdate'
        description: Representation that describes the discount
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityDiscount'
          description: The discount was successfully updated. The result is in the body.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility or discount not found
      summary: Update facility discount
      tags:
        - Facilities (Core)
  /api/facilities/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Facility
      operationId: searchFacility
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilitySearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List facilities (search)
      x-fft-permissions:
        - FACILITY_READ
      tags:
        - Facilities (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/facilitygroups:
    get:
      deprecated: false
      description: Get all facility groups with pagination.
      operationId: getAllFacilityGroups
      parameters:
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: tenantFacilityGroupId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityGroups'
          description: The facility groups that were found based on the given filters.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List facility groups
      x-fft-permissions:
        - FACILITY_GROUP_READ
      tags:
        - Facility Groups (Core)
    post:
      deprecated: false
      description: Creates a new facility group.
      operationId: addFacilityGroup
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityGroupForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityGroup'
          description: The facility group was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create facility group
      x-fft-permissions:
        - FACILITY_GROUP_WRITE
      tags:
        - Facility Groups (Core)
  /api/facilitygroups/{facilityGroupId}:
    delete:
      deprecated: false
      description: Delete facility group by id.
      operationId: deleteFacilityGroup
      parameters:
        - in: path
          name: facilityGroupId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facility group was found and deleted.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete facility group
      x-fft-permissions:
        - FACILITY_GROUP_WRITE
      tags:
        - Facility Groups (Core)
    get:
      deprecated: false
      description: Get facility group by id.
      operationId: getFacilityGroup
      parameters:
        - in: path
          name: facilityGroupId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityGroup'
          description: Facility group was found. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get facility group
      x-fft-permissions:
        - FACILITY_GROUP_READ
      tags:
        - Facility Groups (Core)
    patch:
      deprecated: false
      description: >-
        Replace facility group by id. All updatable fields will be replaced with
        the values from the request. Fields that are not included in the request
        will be removed from the entity.
      operationId: replaceFacilityGroup
      parameters:
        - in: path
          name: facilityGroupId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityGroupForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityGroup'
          description: >-
            Facility group was replaced. The replaced facility group is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update facility group
      x-fft-permissions:
        - FACILITY_GROUP_WRITE
      tags:
        - Facility Groups (Core)
  /api/facilitygroups/{facilityGroupId}/actions:
    post:
      deprecated: false
      description: >-
        Perform action on a facility group. Supported actions are defined in the
        request body.
      operationId: facilityGroupAction
      parameters:
        - in: path
          name: facilityGroupId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddFacilitiesToGroupActionParameter'
                - $ref: >-
                    #/components/schemas/AddFacilitiesToGroupVersionlessActionParameter
                - $ref: >-
                    #/components/schemas/RemoveFacilitiesFromGroupActionParameter
                - $ref: >-
                    #/components/schemas/RemoveFacilitiesFromGroupVersionlessActionParameter
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityGroup'
          description: Updated facility group in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call facility group action
      x-fft-permissions:
        - FACILITY_GROUP_WRITE
      tags:
        - Facility Groups (Core)
  /api/facilitygroups/search:
    post:
      deprecated: false
      description: Search for FacilityGroup
      operationId: searchFacilityGroup
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityGroupSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityGroupPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List facility groups (search)
      x-fft-permissions:
        - FACILITY_GROUP_READ
      tags:
        - Facility Groups (Core)
  /api/features:
    get:
      description: ''
      operationId: getFeatures
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Feature'
          description: The available feature for all active modules
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List features
      tags:
        - Features (Infrastructure)
  /api/features/{featureName}:
    get:
      description: ''
      operationId: getFeature
      parameters:
        - description: Name of the feature requested
          in: path
          name: featureName
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feature'
          description: The requested feature
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get feature
      tags:
        - Features (Infrastructure)
    patch:
      description: ''
      operationId: patchFeature
      parameters:
        - description: Name of the feature requested
          in: path
          name: featureName
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeaturePatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feature'
          description: >-
            Module was found & patch-set has been applied. The patched entity is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update feature
      tags:
        - Features (Infrastructure)
  /api/handovercontainers:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        all Handover Container respecting the given filter
      operationId: getHandoverContainers
      parameters:
        - description: entity to start after
          in: query
          name: startAfter
          required: false
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            type: integer
        - description: facilities to filter the results
          in: query
          name: facilityRefs
          required: false
          schema:
            example:
              - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
              - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
            items:
              type: string
            maxItems: 50
            type: array
        - description: handover job to filter the containers for by reference
          in: query
          name: handoverJobRef
          required: false
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedHandoverContainer'
          description: All HandoverContainer matching the given parameters.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List handover container
      x-fft-permissions:
        - HANDOVER_CONTAINER_READ
      tags:
        - Handovers (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create new Handover Container
      operationId: createHandoverContainer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverContainerForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverContainer'
          description: Created Handover Container.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create handover container
      x-fft-permissions:
        - HANDOVER_CONTAINER_WRITE
      tags:
        - Handovers (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/handovercontainers/{handoverContainerId}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete handover container
      operationId: deleteHandoverContainerById
      parameters:
        - description: id of the handover container
          in: path
          name: handoverContainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: HandoverContainer successfully deleted.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete handover container
      x-fft-permissions:
        - HANDOVER_CONTAINER_WRITE
      tags:
        - Handovers (Operations)
      x-badges:
        - color: orange
          label: BETA
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        handover container
      operationId: getHandoverContainerById
      parameters:
        - description: id of the handover container
          in: path
          name: handoverContainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverContainer'
          description: HandoverContainer matching the given id.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get handover container
      x-fft-permissions:
        - HANDOVER_CONTAINER_READ
      tags:
        - Handovers (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/handovercontainers/{handoverContainerId}/stack:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Return the stack of a given handover container if found
      operationId: getStackForHandoverContainer
      parameters:
        - description: id of the handover container
          in: path
          name: handoverContainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stack'
          description: Stack for the given handoverContainer matching the given id.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get handover container stack
      x-fft-permissions:
        - HANDOVER_CONTAINER_READ
        - STACKS_READ
      tags:
        - Handovers (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/handoverjobs:
    get:
      description: ''
      operationId: getAllHandoverjobs
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: This query can be used to find handoverjobs for a referenced pickjob
          in: query
          name: pickJobRef
          required: false
          schema:
            type: string
        - description: >-
            This query can be used to find handoverjobs for a referenced
            shipment
          in: query
          name: shipmentRef
          required: false
          schema:
            type: string
        - description: Reference the assigned user on this entity - id or username
          in: query
          name: assignedUser
          required: false
          schema:
            type: string
        - description: >-
            Reference to the facility you want to get the corresponding
            handoverJobs
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: >-
            Reference to the status you want to get the corresponding
            handoverJobs
          explode: true
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the carriers you want to get the corresponding
            handoverJobs
          in: query
          name: carrierRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the channel you want to get the corresponding
            handoverJobs
          in: query
          name: channel
          required: false
          schema:
            type: string
        - description: Parameter to filter anonymized handover jobs
          in: query
          name: anonymized
          required: false
          schema:
            type: boolean
        - description: >-
            This query can be used to find handoverjobs with the given
            tenantOrderId
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - description: Perform full text search over all searchable attributes
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: Start date range for pick jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End date range for pick jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedHandoverjobs'
          description: Handoverjobs are found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List handover jobs
      tags:
        - Handovers (Operations)
    post:
      operationId: addHandoverjob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverjobForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Handoverjob'
          description: >-
            The handoverjob was successfully created. The Location header
            contains the URL of it.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create handover job
      tags:
        - Handovers (Operations)
  /api/handoverjobs/{handoverjobId}:
    get:
      description: ''
      operationId: getHandoverjob
      parameters:
        - description: ID of the handoverjob you want to get
          in: path
          name: handoverjobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Handoverjob'
          description: >-
            Handoverjob was found & you were allowed to access it. The result is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get handover job
      tags:
        - Handovers (Operations)
    patch:
      description: ''
      operationId: patchHandoverjob
      parameters:
        - description: ID of handoverjob you want to patch
          in: path
          name: handoverjobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverjobPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Handoverjob'
          description: >-
            Handoverjob was found & patch-set has been applied. The patched
            entity is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update handover job
      tags:
        - Handovers (Operations)
  /api/handoverjobs/{handoverJobId}/actions:
    post:
      operationId: handoverJobAction
      parameters:
        - description: Reference to the handover job you want to call the action for
          in: path
          name: handoverJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverJobActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Handoverjob'
          description: Updated Handover job in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call handover job action
      tags:
        - Handovers (Operations)
  /api/handoverjobs/search:
    post:
      deprecated: false
      description: Search for HandoverJob
      operationId: searchHandoverJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverJobSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverJobPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List handover job (search)
      x-fft-permissions:
        - HANDOVERJOB_READ
      tags:
        - Handovers (Operations)
  /api/health:
    get:
      description: ''
      operationId: healthCheck
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResult'
          description: Result of all tested dependencies for their health status
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Manual reroute configuration not found
      summary: Health check
      tags:
        - Health (Infrastructure)
  /api/inboundprocesses:
    get:
      deprecated: false
      description: ''
      operationId: getInboundProcesses
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            enum:
              - ORIGIN_NAME_ASC
              - REQUESTED_DATE_ASC
              - LAST_MODIFIED_ASC
              - ORIGIN_NAME_DESC
              - REQUESTED_DATE_DESC
              - LAST_MODIFIED_DESC
            type: string
        - in: query
          name: facilityRef
          required: false
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            items:
              type: string
            type: array
        - in: query
          name: scannableCode
          required: false
          schema:
            type: string
        - explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              enum:
                - OPEN
                - PARTIAL_DELIVERY
                - ON_HOLD
                - CLOSED
              type: string
            type: array
        - description: >
            Matches partial values; The queries terms and therefore the result
            set of the query can change in the future:

            - tenantInboundProcessId

            - scannableCodes

            - receipts.receivedItems.tenantArticleId

            - purchaseOrder.requestedItems.tenantArticleId

            - purchaseOrder.supplier.name

            - values of related listings
              - listing.title
              - listing.scannableCodes
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: >
            Only matches complete values; The queries terms and therefore the
            result set of the query can change in the future:

            - tenantInboundProcessId

            - scannableCodes

            - receipts.receivedItems.tenantArticleId

            - purchaseOrder.requestedItems.tenantArticleId

            - purchaseOrder.supplier.name

            - values of related listings
              - listing.title
              - listing.scannableCodes
          in: query
          name: searchTermExact
          required: false
          schema:
            type: string
        - in: query
          name: purchaseOrder_cancelled
          required: false
          schema:
            type: boolean
        - explode: false
          in: query
          name: receipt_status
          required: false
          schema:
            items:
              enum:
                - OPEN
                - IN_PROGRESS
                - FINISHED
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPaginatedResult'
          description: Paginated result containing the matching Inbound Process entities
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List inbound processes
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
    post:
      deprecated: false
      description: ''
      operationId: createInboundProcess
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessForCreation'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcess'
          description: Created Inbound Process entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create inbound process
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/inboundprocesses/{inboundProcessId}:
    delete:
      deprecated: false
      description: ''
      operationId: deleteInboundProcess
      parameters:
        - in: path
          name: inboundProcessId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Inbound Process successfully deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Delete inbound process
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
    get:
      deprecated: false
      description: ''
      operationId: getInboundProcess
      parameters:
        - in: path
          name: inboundProcessId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcess'
          description: Requested Inbound Process entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get inbound process
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
    patch:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: Patch InboundProcess
      parameters:
        - in: path
          name: inboundProcessId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessForPatch'
        required: true
      responses:
        '200':
          description: Inbound Process successfully patched
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update inbound process
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/inboundprocesses/{inboundProcessId}/purchaseorder:
    put:
      deprecated: false
      description: >-
        Creates or updates the specific purchase order of an existing inbound
        process.
      operationId: upsertInboundProcessPurchaseOrder
      parameters:
        - in: path
          name: inboundProcessId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessPurchaseOrderForUpsert'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPurchaseOrder'
          description: Purchase order successfully updated on inbound process
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPurchaseOrder'
          description: Purchase order successfully created on inbound process
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update purchase order
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/inboundprocesses/{inboundProcessId}/receipts:
    post:
      deprecated: false
      description: Adds a receipt to an inbound process.
      operationId: addReceiptToInboundProcess
      parameters:
        - in: path
          name: inboundProcessId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundReceiptForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundReceipt'
          description: Receipt was added to the inbound process
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create inbound process receipt
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/inboundprocesses/attachments:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: createAttachment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundAttachmentForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundAttachment'
          description: Created attachment
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create attachment
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
      x-badges:
        - color: red
          label: ALPHA
  /api/inboundprocesses/attachments/{attachmentId}/signedurl:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getSignedAttachmentUrl
      parameters:
        - in: path
          name: attachmentId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: Signed url
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get signed attachment url
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
      x-badges:
        - color: red
          label: ALPHA
  /api/inboundprocesses/search:
    post:
      deprecated: false
      description: Search for InboundProcess
      operationId: searchInboundProcess
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List inbound processes (search)
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
  /api/inboundreceiptjobs:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getInboundReceiptJobs
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: facilityRef
          required: false
          schema:
            items:
              type: string
            type: array
        - explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              enum:
                - OPEN
                - PARTIAL_DELIVERY
                - ON_HOLD
                - CLOSED
              type: string
            type: array
        - in: query
          name: searchTerm
          required: false
          schema:
            minLength: 1
            type: string
        - in: query
          name: searchTermExact
          required: false
          schema:
            minLength: 1
            type: string
        - in: query
          name: fromDate
          required: false
          schema:
            example: 2026-06-17T12:00:00.000Z
            format: date-time
            type: string
        - in: query
          name: toDate
          required: false
          schema:
            example: 2026-06-17T12:00:00.000Z
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundReceiptJobPaginatedResult'
          description: Paginated Inbound Receipt Jobs
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List inbound receipt jobs
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/inboundreceiptjobs/{inboundEntryId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getInboundReceiptJob
      parameters:
        - in: path
          name: inboundEntryId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundReceiptJob'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get inbound receipt job
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/itemreturnjobs:
    get:
      deprecated: false
      description: Returns the item return jobs matching the given parameters.
      operationId: getItemReturnJobs
      parameters:
        - description: facility to filter the results
          in: query
          name: facilityId
          required: false
          schema:
            type: string
        - description: scannableCodes of the item return job to filter the results
          in: query
          name: itemReturnJobScannableCodes
          required: false
          schema:
            items:
              type: string
            type: array
        - description: scannableCodes of the item return to filter the results
          in: query
          name: itemReturnScannableCodes
          required: false
          schema:
            items:
              type: string
            type: array
        - description: ItemReturnJobStatus to filter the results
          in: query
          name: itemReturnJobStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: ItemReturnStatus of an included ItemReturn to filter the results
          in: query
          name: itemReturnStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Term by which to search through the fields
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: show anonymized entities or not
          in: query
          name: anonymized
          required: false
          schema:
            type: boolean
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJobs'
          description: All Item Return Jobs matching the given parameters
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List item return jobs
      x-fft-permissions:
        - RETURN_READ
      tags:
        - Returns (Operations)
    post:
      deprecated: false
      description: Creates a new item return job.
      operationId: createItemReturnJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemReturnJobForCreation'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Created entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create item return job
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}:
    get:
      deprecated: false
      description: Returns an item return job with the provided id.
      operationId: getItemReturnJob
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Returns Item Return Job with the provided id
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get item return job
      x-fft-permissions:
        - RETURN_READ
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/actions:
    post:
      deprecated: false
      description: >-
        Applies an action to an Item Return Job. Check
        ItemReturnJobActionsParameters for available actions.
      operationId: updateItemReturnJob
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/FinishItemReturnJobActionParameter'
                - $ref: '#/components/schemas/StartItemReturnJobActionParameter'
                - $ref: '#/components/schemas/RestartItemReturnJobActionParameter'
                - $ref: >-
                    #/components/schemas/ChangeLineItemsToNotReturnableInItemReturnJobActionParameter
                - $ref: >-
                    #/components/schemas/ChangeLineItemsToReturnableInItemReturnJobActionParameter
                - $ref: >-
                    #/components/schemas/ReplaceLineItemsOnItemReturnJobActionParameter
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Call item return job action
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns:
    get:
      deprecated: false
      description: Returns the item returns for a given item return job.
      operationId: getItemReturns
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ItemReturn'
                type: array
          description: Get all item returns for a given item return job
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List item returns
      x-fft-permissions:
        - RETURN_READ
      tags:
        - Returns (Operations)
    post:
      deprecated: false
      description: Create a new item return for an item return job
      operationId: createItemReturn
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddItemReturnToItemReturnJob'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: ItemReturnJob containing the newly created item return
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create item return
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}:
    delete:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete an item return from an item return job
      operationId: deleteItemReturn
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - description: id of the item return you want to delete
          in: path
          name: itemReturnId
          required: true
          schema:
            type: string
        - description: version of the item return job to delete the item return for
          in: query
          name: itemReturnJobVersion
          required: true
          schema:
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: >-
            item return was found and successfully deleted. Updated item return
            job is returned.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete item return
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
    get:
      deprecated: false
      description: Returns a specific item return for a given item return job.
      operationId: getItemReturn
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - description: id of the item return you want to read
          in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturn'
          description: Get a specific item return
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get item return
      x-fft-permissions:
        - RETURN_READ
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions:
    post:
      deprecated: false
      description: >-
        Applies an action to an Item Return. Check ItemReturnActionsParameters
        for available actions.
      operationId: itemReturnActions
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/AnnounceItemReturnActionParameter'
                - $ref: '#/components/schemas/OpenItemReturnActionParameter'
                - $ref: '#/components/schemas/StartItemReturnActionParameter'
                - $ref: '#/components/schemas/PauseItemReturnActionParameter'
                - $ref: '#/components/schemas/FinishItemReturnActionParameter'
                - $ref: '#/components/schemas/CancelItemReturnActionParameter'
                - $ref: '#/components/schemas/WaitForInputItemReturnActionParameter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Call item return action
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels:
    post:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns all parcels for an itemReturn.
      operationId: createItemReturnParcel
      parameters:
        - description: itemReturnJobId
          in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - description: id of the itemReturn to create a parcel for
          in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelForCreation'
        description: Payload of the parcel you want to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: Create a parcel for an itemReturn
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Create item return parcel
      tags:
        - Returns (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems:
    put:
      deprecated: false
      description: Replace returned line items of an item return of an item return job.
      operationId: replaceReturnedLineItems
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceReturnedLineItems'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: >-
            The returned line items were successfully updated. Updated item
            return job is returned.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update returned line items
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}:
    patch:
      deprecated: false
      description: >-
        Patch for a ItemReturn LineItem. This is used to update the returned
        line item.
      operationId: updateItemReturnLineItem
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - in: path
          name: itemReturnId
          required: true
          schema:
            type: string
        - description: id of the returnedLineItem
          in: path
          name: returnedLineItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemReturnLineItemForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated ItemReturnJob
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update returned line item
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnednotreturnablelineitems:
    put:
      deprecated: false
      description: >-
        Replace returned not returnable line items of an item return of an item
        return job.
      operationId: replaceReturnedNotReturnableLineItems
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceReturnedNotReturnableLineItems'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: >-
            The not returnable returned line items were successfully updated.
            Updated item return job is returned.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update returned not returnable line items
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnednotreturnablelineitems/{returnedNotReturnableLineItemId}:
    patch:
      deprecated: false
      description: >-
        Patch for a ItemReturn LineItem. This is used to update a returned not
        returnable line item.
      operationId: updateItemReturnNotReturnableLineItem
      parameters:
        - in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - in: path
          name: itemReturnId
          required: true
          schema:
            type: string
        - description: id of the returnedLineItem
          in: path
          name: returnedNotReturnableLineItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemReturnNotReturnableLineItemForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated ItemReturnJob
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update returned not returnable line item
      x-fft-permissions:
        - RETURN_WRITE
      tags:
        - Returns (Operations)
  /api/itemreturns:
    get:
      deprecated: false
      description: Returns the item returns matching the given parameters.
      operationId: findItemReturns
      parameters:
        - description: >-
            Search term you want to get the corresponding item returns. Search
            will be performed on multiple fields, including return id, tenant
            order id, customer name, tenant article ids, artile titles
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: ItemReturnStatus of an included ItemReturn to filter the results
          in: query
          name: itemReturnStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            ItemReturnLineItemStatus of an included itemReturnLineItem to filter
            the results
          in: query
          name: itemReturnLineItemStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            type: integer
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: sorting for the results
          in: query
          name: orderBy
          required: false
          schema:
            type: string
        - description: show anonymized entities or not
          in: query
          name: anonymized
          required: false
          schema:
            type: boolean
        - description: facilities to filter the results
          in: query
          name: facilityRefs
          required: false
          schema:
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturns'
          description: All Item Returns matching the given parameters
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get item returns
      x-fft-permissions:
        - RETURN_READ
      tags:
        - Returns (Operations)
  /api/labels:
    post:
      deprecated: false
      description: Create label
      operationId: addLabel
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
          description: The label was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create label
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - Label (Operations)
  /api/labels/{id}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        label
      operationId: getLabel
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
          description: Label was found. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get label
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Label (Operations)
      x-badges:
        - color: red
          label: ALPHA
    patch:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update label
      operationId: patchLabel
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
          description: >-
            Label was found and patch-set has been applied. The patched entity
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update label
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - Label (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/labels/{id}/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Performs provided labelAction
      operationId: performLabelAction
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/RequestLabelAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
          description: >-
            Label was found and provided action has been applied. The patched
            entity is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Performs provided labelAction
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - Label (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/labels/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Label
      operationId: searchLabel
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LabelPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Labels (search)
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Label (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/linkedservicejobs:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />List
        linked service jobs
      operationId: getLinkedServiceJobs
      parameters:
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
            minLength: 1
            type: string
        - description: facilities to filter to
          in: query
          name: facilityIds
          required: false
          schema:
            example:
              - 6027cece-93b8-4628-9314-a3f455af9e46
            items:
              type: string
            maxItems: 20
            type: array
        - description: >-
            Reference to the statuses you want to get the corresponding linked
            service jobs
          in: query
          name: status
          required: false
          schema:
            example: OPEN
            items:
              enum:
                - OPEN
                - IN_PROGRESS
                - FINISHED
                - CANCELLED
                - OBSOLETE
                - NOT_READY
              type: string
            maxItems: 10
            type: array
        - description: sort order
          in: query
          name: orderBy
          required: false
          schema:
            enum:
              - LAST_MODIFIED_ASC
              - LAST_MODIFIED_DESC
              - TARGET_TIME_ASC
              - TARGET_TIME_DESC
            example: TARGET_TIME_ASC
            type: string
        - description: Start target date range for linked service jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End target date range for linked service jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: type of channel you want to filter for
          in: query
          name: channel
          required: false
          schema:
            enum:
              - COLLECT
              - SHIPPING
            example: COLLECT
            type: string
        - description: >-
            Search term you want to get the corresponding linked service jobs.
            Search will be performed on multiple fields, like tenantOrderId,
            consumerName, tenantArticleId and more
          in: query
          name: searchTerm
          required: false
          schema:
            example: John Doe
            minLength: 1
            type: string
        - description: >-
            Reference to the username you want to get the corresponding
            linkedServiceJobs for
          in: query
          name: modifiedByUsername
          required: false
          schema:
            example: john.doe
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobsResult'
          description: LinkedServiceJobs can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List linked service jobs
      x-fft-permissions:
        - LINKED_SERVICE_JOBS_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/linkedservicejobs/{linkedServiceJobsId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        linked service jobs by id
      operationId: getLinkedServiceJobsById
      parameters:
        - description: ID of LinkedServiceJobs you want to get
          in: path
          name: linkedServiceJobsId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobs'
          description: LinkedServiceJobs can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get linked service jobs
      x-fft-permissions:
        - LINKED_SERVICE_JOBS_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Add
        a ServiceJobLink to a LinkedServiceJob on root level.
      operationId: addServiceJobLink
      parameters:
        - description: ID of LinkedServiceJobs you want to alter
          in: path
          name: linkedServiceJobsId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobLinkForAdding'
        description: Desired ServiceJobLink to add
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobs'
          description: The ServiceJobLink was successfully added to the LinkedServiceJobs.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create service job link
      x-fft-permissions:
        - LINKED_SERVICE_JOBS_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId}:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Add
        a ServiceJobLink to a ServiceJobLink inside the LinkedServiceJob.
      operationId: addNestedServiceJobLink
      parameters:
        - description: ID of LinkedServiceJobs you want to alter
          in: path
          name: linkedServiceJobsId
          required: true
          schema:
            type: string
        - description: >-
            ID of ServiceJobLink you want to add the new ServiceJobLink
            underneath
          in: path
          name: serviceJobLinkId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobLinkForAdding'
        description: Desired ServiceJobLink to add
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobs'
          description: >-
            The ServiceJobLink was successfully added nested inside the
            LinkedServiceJobs.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create nested service job link
      x-fft-permissions:
        - LINKED_SERVICE_JOBS_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/linkedservicejobs/search:
    post:
      deprecated: false
      description: Search for LinkedServiceJobs
      operationId: searchLinkedServiceJobs
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinkedServiceJobsSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobsPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List linked service jobs (search)
      x-fft-permissions:
        - LINKED_SERVICE_JOBS_READ
      tags:
        - Services (Operations)
  /api/listings:
    put:
      deprecated: false
      description: Bulk upsert listings independently of their facility
      operationId: bulkUpsertListings
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingBulkUpsertPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingBulkUpsertResponse'
          description: Result of the bulk upsert operation
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Create and update listings
      x-fft-permissions:
        - LISTING_WRITE
      tags:
        - Listings (Core)
  /api/listings/search:
    post:
      deprecated: false
      description: Search for Listing
      operationId: searchListing
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List listings (search)
      x-fft-permissions:
        - LISTING_READ
      tags:
        - Listings (Core)
  /api/loadunits:
    delete:
      deprecated: false
      description: Soft delete load units
      operationId: deleteLoadUnits
      parameters:
        - description: Reference to the pickJob of which you want to delete the loadUnits
          in: query
          name: pickJobRef
          required: false
          schema:
            type: string
        - description: Load unit ids
          explode: true
          in: query
          name: id
          required: false
          schema:
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnits'
          description: Load units have successfully been set to OBSOLETE.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            The syntax of the request content was correct, but it was unable to
            process the contained instructions, possibly due to semantic errors.
      summary: Soft deletes load units by setting them to status OBSOLETE.
      x-fft-permissions:
        - LOADUNIT_WRITE
      tags:
        - Picking (Operations)
    get:
      deprecated: false
      description: List load units
      operationId: getAllLoadUnits
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of loadUnits to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            type: integer
        - description: query load units with the given pickJobRef
          in: query
          name: pickJobRef
          required: false
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            type: string
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            example: de_DE
            type: string
        - description: >-
            The statuses you want to filter the load units by. If not provided,
            only load units in status AVAILABLE will be returned. An empty array
            will return all load units regardless of status.
          in: query
          name: statuses
          required: false
          schema:
            example: '[AVAILABLE]'
            items:
              enum:
                - AVAILABLE
                - OBSOLETE
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnits'
          description: Load units are found
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List load units
      x-fft-permissions:
        - LOADUNIT_READ
      tags:
        - Picking (Operations)
    post:
      deprecated: false
      description: Create load units
      operationId: addLoadUnit
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitsForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadUnit'
                type: array
          description: Load units are successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create load units
      x-fft-permissions:
        - LOADUNIT_WRITE
      tags:
        - Picking (Operations)
  /api/loadunits/{loadUnitId}:
    delete:
      deprecated: false
      description: Soft delete a load unit
      operationId: deleteLoadUnit
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnit'
          description: Load unit has successfully been set to OBSOLETE.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Soft deletes load unit by setting them to status OBSOLETE.
      x-fft-permissions:
        - LOADUNIT_WRITE
      tags:
        - Picking (Operations)
    get:
      deprecated: false
      description: Get load unit
      operationId: getLoadUnitByID
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnit'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get load unit
      x-fft-permissions:
        - LOADUNIT_READ
      tags:
        - Picking (Operations)
    patch:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />LoadUnitPatchActions: Deprecated - For future usage please use the
        /actions endpoints mentioned in the corresponding - PatchActions 
        LoadUnit: Partial Patch on this entity.
      operationId: patchLoadUnitByID
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/LoadUnitPatchActions'
                - $ref: '#/components/schemas/LoadUnit'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnit'
          description: The updated load unit
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update load unit.
      x-fft-permissions:
        - LOADUNIT_WRITE
      tags:
        - Picking (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/loadunits/{loadUnitId}/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Applies actions to a load unit. Check LoadUnitActionsParameter for
        available actions.
      operationId: loadUnitActions
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/LoadUnitLineItemUpdateRecordableAttributesActionParameter
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnit'
          description: Updated Load Unit via actions
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: >-
        Applies actions to a load unit. Check LoadUnitActionsParameter for
        available actions.
      x-fft-permissions:
        - LOADUNIT_WRITE
      tags:
        - Picking (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/loadunits/{loadUnitId}/stack:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        load unit stack
      operationId: getStackForLoadUnit
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stack'
          description: The found stack for this load unit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get load unit stack
      x-fft-permissions:
        - LOADUNIT_READ
        - STACKS_READ
      tags:
        - Picking (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/loadunittypes:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Return all load unit types configured. Deprecated, please use
        OperativeContainerTypes
      operationId: getLoadUnitTypes
      parameters:
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            example: 10
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadUnitType'
                type: array
          description: All load unit types
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List load unit types
      x-fft-permissions:
        - LOADUNITTYPE_READ
      tags:
        - Picking (Operations)
    post:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create load unit type. Deprecated, please use OperativeContainerTypes
      operationId: createLoadUnitTypes
      parameters:
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitTypeForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: Successfully created resource.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create load unit type
      x-fft-permissions:
        - LOADUNITTYPE_WRITE
      tags:
        - Picking (Operations)
  /api/loadunittypes/{loadUnitTypeId}:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        load unit type. Deprecated, please use OperativeContainerTypes
      operationId: getLoadUnitTypeByID
      parameters:
        - in: path
          name: loadUnitTypeId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: The found load unit type.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get load unit type
      x-fft-permissions:
        - LOADUNITTYPE_READ
      tags:
        - Picking (Operations)
    patch:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update load unit type. Deprecated, please use OperativeContainerTypes
      operationId: updateLoadUnitType
      parameters:
        - in: path
          name: loadUnitTypeId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitTypePatchActions'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: Load Unit Type updated successfully.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update load unit type
      x-fft-permissions:
        - LOADUNITTYPE_WRITE
      tags:
        - Picking (Operations)
  /api/loadunittypes/{loadUnitTypeId}/icon:
    put:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update load unit type icon. Deprecated, please use
        OperativeContainerTypes
      operationId: uploadLoadUnitTypeIcon
      parameters:
        - in: path
          name: loadUnitTypeId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions if found. If not
            provided the default locale is used. Example de_DE
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NamedFile'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: Successfully updated load unit type icon
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: Successfully created load unit type icon.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update load unit type icon
      x-fft-permissions:
        - LOADUNITTYPE_WRITE
      tags:
        - Picking (Operations)
  /api/lookuprecorditems/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for LookupRecordItem
      operationId: searchLookupRecordItem
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookupRecordItemSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecordItemPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List all record items (search cached for 5 minutes)
      x-fft-permissions:
        - LOOKUP_RECORD_READ
      tags:
        - Checkout Options (DOMS)
      x-badges:
        - color: orange
          label: BETA
  /api/lookuprecords:
    get:
      deprecated: false
      description: Retrieves all lookup records.
      operationId: getAllLookupRecords
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecord'
          description: Successfully retrieved the lookup records.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get all lookup records
      x-fft-permissions:
        - LOOKUP_RECORD_READ
      tags:
        - Checkout Options (DOMS)
    post:
      deprecated: false
      description: Creates a single lookup record.
      operationId: createLookupRecord
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookupRecordForCreation'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecord'
          description: Successfully created the lookup record.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create a lookup record by its ID
      x-fft-permissions:
        - LOOKUP_RECORD_WRITE
      tags:
        - Checkout Options (DOMS)
  /api/lookuprecords/{recordId}:
    delete:
      deprecated: false
      description: Deletes a single lookup record using its unique identifier.
      operationId: deleteLookupRecord
      parameters:
        - in: path
          name: recordId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecord'
          description: Successfully deleted the lookup record.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete a lookup record by its ID
      x-fft-permissions:
        - LOOKUP_RECORD_WRITE
      tags:
        - Checkout Options (DOMS)
    get:
      deprecated: false
      description: Retrieves a single lookup record using its unique identifier.
      operationId: getLookupRecord
      parameters:
        - in: path
          name: recordId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecord'
          description: Successfully retrieved the lookup record.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get a lookup record by its ID
      x-fft-permissions:
        - LOOKUP_RECORD_READ
      tags:
        - Checkout Options (DOMS)
    put:
      deprecated: false
      description: Updates a single lookup record.
      operationId: putLookupRecord
      parameters:
        - in: path
          name: recordId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LookupRecordForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LookupRecord'
          description: Successfully updated the lookup record.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Updates a whole lookup record by its ID
      x-fft-permissions:
        - LOOKUP_RECORD_WRITE
      tags:
        - Checkout Options (DOMS)
  /api/measurementunits:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getAllMeasurementUnits
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of measurementUnits to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: key of the measurementUnit
          in: query
          name: key
          required: false
          schema:
            type: string
        - description: >-
            Provide the localized names for the measurementUnit. If not provided
            the default locale is used., for example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementUnits'
          description: The found measurementUnit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: List measurement units
      tags:
        - Measurement Units (Core)
      x-badges:
        - color: orange
          label: BETA
    post:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: createMeasurementUnit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasurementUnitForCreation'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementUnit'
          description: Successfully created the measurementUnit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Create measurement unit
      tags:
        - Measurement Units (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/measurementunits/{measurementUnitId}:
    delete:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: deleteMeasurementUnit
      parameters:
        - in: path
          name: measurementUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted the measurementUnit.
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Delete measurement unit
      tags:
        - Measurement Units (Core)
      x-badges:
        - color: orange
          label: BETA
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getMeasurementUnitByID
      parameters:
        - in: path
          name: measurementUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementUnit'
          description: The found measurementUnit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get measurement unit
      tags:
        - Measurement Units (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: updateMeasurementUnit
      parameters:
        - in: path
          name: measurementUnitId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasurementUnitForCreation'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementUnit'
          description: Successfully updated the measurementUnit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Update measurement unit
      tags:
        - Measurement Units (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/notifications/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Notification
      operationId: searchNotification
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List notifications (search)
      x-fft-permissions:
        - NOTIFICATION_READ
      tags:
        - Notification Center Configuration (Core)
      x-badges:
        - color: red
          label: ALPHA
  /api/operativecontainertypes:
    get:
      deprecated: false
      description: >-
        Returns all operativeContainerTypes that match the given query
        parameters.
      operationId: getOperativeContainerTypes
      parameters:
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: OperativeType you want to filter by
          in: query
          name: operativeType
          required: false
          schema:
            enum:
              - PICKING
              - PACKING_SOURCE
              - PACKING_TARGET
              - HANDOVER
              - SERVICE
            type: string
        - description: ScannableIdentifier you want to filter by
          in: query
          name: scannableIdentifier
          required: false
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the
            operativeContainerTypes. If not provided the default locale is used.
            For example de_DE.
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerTypesResponse'
          description: Found operativeContainerTypes matching the given parameters
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List operative container types
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Operative Container (Operations)
    post:
      deprecated: false
      description: Creates a new operativeContainerType.
      operationId: createOperativeContainerType
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperativeContainerTypeForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Successfully created resource.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create operative container type
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Operative Container (Operations)
  /api/operativecontainertypes/{operativeContainerTypeId}:
    get:
      deprecated: false
      description: Returns the operativeContainerType with the given ID.
      operationId: getOperativeContainerTypeById
      parameters:
        - in: path
          name: operativeContainerTypeId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the
            operativeContainerTypes. If not provided the default locale is used.
            For example de_DE.
          in: query
          name: locale
          required: false
          schema:
            example: en-US
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Found operativeContainerType by given ID
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get operative container type
      x-fft-permissions:
        - CONFIG_READ
      tags:
        - Operative Container (Operations)
    patch:
      deprecated: false
      description: Updates the operativeContainerType with the given ID.
      operationId: updateOperativeContainerTypeById
      parameters:
        - in: path
          name: operativeContainerTypeId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperativeContainerTypeForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Successfully updated operativeContainerType by given ID
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update operative container type
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Operative Container (Operations)
  /api/operativecontainertypes/{operativeContainerTypeId}/icon:
    put:
      deprecated: false
      description: Uploads or replaces the icon for the given operative container type.
      operationId: uploadOperativeContainerTypeIcon
      parameters:
        - in: path
          name: operativeContainerTypeId
          required: true
          schema:
            type: string
        - in: query
          name: locale
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NamedFile'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Successfully updated operative container type icon.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Successfully created operative container type icon.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update operative container type icon
      x-fft-permissions:
        - CONFIG_WRITE
      tags:
        - Operative Container (Operations)
  /api/operativeprocesses:
    get:
      deprecated: false
      description: Get all operative processes
      operationId: getOperativeProcesses
      parameters:
        - description: facility to filter the results
          in: query
          name: facilityId
          required: true
          schema:
            type: string
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeProcessPaginatedResult'
          description: All operative processes matching the given parameters
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List operative processes
      x-fft-permissions:
        - OPERATIVE_PROCESS_READ
      tags:
        - Operative Process (Operations)
  /api/operativeprocesses/{operativeProcessId}:
    get:
      deprecated: false
      description: Get the operative processes for a specific id
      operationId: getOperativeProcessById
      parameters:
        - in: path
          name: operativeProcessId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeProcess'
          description: Found operativeProcess by given ID
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get operative process
      x-fft-permissions:
        - OPERATIVE_PROCESS_READ
      tags:
        - Operative Process (Operations)
  /api/operativeprocesses/{operativeProcessId}/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Perform action for the given operative process
      operationId: applyOperativeProcessAction
      parameters:
        - in: path
          name: operativeProcessId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/AddTargetTimeToOperativeProcessEntitiesActionParameter
        description: Desired action to apply to given operativeProcess
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableOperativeProcessActions'
          description: OperativeProcess after action has been applied
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Perform action for the given operative process
      x-fft-permissions:
        - OPERATIVE_PROCESS_WRITE
      tags:
        - Operative Process (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/operativeprocesses/{operativeProcessId}/availableactions:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        all available actions for a specific operative process
      operationId: getAvailableOperativeProcessActions
      parameters:
        - in: path
          name: operativeProcessId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableOperativeProcessActions'
          description: Available actions for the given operative process
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get available operative process actions
      x-fft-permissions:
        - OPERATIVE_PROCESS_READ
      tags:
        - Operative Process (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/orderrecords:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />List
        order records with pagination and optional filters
      operationId: listOrderRecords
      parameters:
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: size
          required: false
          schema:
            maximum: 500
            type: number
        - in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - in: query
          name: tenantOrderRecordId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecords'
          description: The order records that were found based on the given filters.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List order records
      x-fft-permissions:
        - ORDER_RECORD_READ
      tags:
        - Order Records (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    put:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create multiple order records in a single request (max 25)
      operationId: bulkCreateOrderRecords
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRecordBulkOperations'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecordBulkOperationsResponse'
          description: The order records have been successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Bulk create order records
      x-fft-permissions:
        - ORDER_RECORD_WRITE
      tags:
        - Order Records (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/orderrecords/{orderRecordId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        a single order record by id
      operationId: getOrderRecord
      parameters:
        - in: path
          name: orderRecordId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecord'
          description: The order record was found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get an order record
      x-fft-permissions:
        - ORDER_RECORD_READ
      tags:
        - Order Records (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/orderrecords/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for OrderRecord
      operationId: searchOrderRecord
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRecordSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderRecordPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List order records (search)
      x-fft-permissions:
        - ORDER_RECORD_READ
      tags:
        - OrderRecords
      x-badges:
        - color: orange
          label: BETA
  /api/orders:
    get:
      description: List orders with optional filtering by tenant order ID or consumer ID.
      operationId: getAllOrders
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: filter orders by tenantOrderId
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - description: filter orders by consumerId
          in: query
          name: consumerId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedOrders'
          description: Orders are found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List orders
      x-fft-permissions:
        - ORDER_READ
      tags:
        - Orders (DOMS)
    post:
      description: Create a new order.
      operationId: addOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderForCreation'
        description: Order object supplied by your shop instance.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: >-
            The order was successfully created. The Location header contains the
            URL of the order.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create order
      x-fft-permissions:
        - ORDER_WRITE
      tags:
        - Orders (DOMS)
  /api/orders/{orderId}:
    get:
      description: Get a specific order by ID.
      operationId: getOrder
      parameters:
        - description: ID of order you want to get
          in: path
          name: orderId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: >-
            Order was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get order
      x-fft-permissions:
        - ORDER_READ
      tags:
        - Orders (DOMS)
    patch:
      description: Update an existing order.
      operationId: updateOrder
      parameters:
        - description: ID of Order you want to patch
          in: path
          name: orderId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderForUpdate'
        description: Request body for updating an order
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: >-
            Order was found & patch-set has been applied. The patched entity is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found, for more information please look at details.
      summary: Update order
      x-fft-permissions:
        - ORDER_WRITE
      tags:
        - Orders (DOMS)
  /api/orders/{orderId}/actions:
    post:
      operationId: orderAction
      parameters:
        - description: Reference to the order you want to call the action for
          in: path
          name: orderId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: Updated Order in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Order not found or expired
      summary: Call order action
      x-fft-permissions:
        - ORDER_WRITE
        - ORDER_CANCEL
        - ORDER_FORCE_CANCEL
        - ORDER_UNLOCK
        - ORDER_CONSUMER_WRITE
      tags:
        - Orders (DOMS)
  /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions:
    post:
      operationId: orderLineItemAction
      parameters:
        - description: Reference to the order you want to call the action for
          in: path
          name: orderId
          required: true
          schema:
            type: string
        - description: Reference to the order line item you want to call the action for
          in: path
          name: orderLineItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderLineItemActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: Updated Order in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call order line item action
      x-fft-permissions:
        - ORDER_WRITE
      tags:
        - Orders (DOMS)
  /api/orders/actions:
    post:
      description: Bulk action of orders
      operationId: bulkOrdersAction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkOrderActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/BulkOrderActionResult'
                type: array
          description: Updated Orders in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Orders not found or expired
      summary: Call bulk orders action
      x-fft-permissions:
        - ORDER_WRITE
        - ORDER_CANCEL
        - ORDER_FORCE_CANCEL
      tags:
        - Orders (DOMS)
  /api/orders/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Order
      operationId: searchOrder
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List orders (search)
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Orders (DOMS)
      x-badges:
        - color: orange
          label: BETA
  /api/packagingunits:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves all PackagingUnits details
      operationId: getAllPackagingUnitDetails
      parameters: []
      responses:
        '200':
          description: Successfully retrieved the PackagingUnits.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get all PackagingUnits details
      x-fft-permissions:
        - PACKAGING_UNITS_READ
      tags:
        - PackagingUnits (DOMS)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates a single PackagingUnitDetail.
      operationId: createPackagingUnitDetail
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackagingUnitDetailForCreation'
        required: true
      responses:
        '200':
          description: Successfully created the PackagingUnitDetail.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create a PackagingUnitDetail by its ID
      x-fft-permissions:
        - PACKAGING_UNITS_WRITE
      tags:
        - PackagingUnits (DOMS)
      x-badges:
        - color: orange
          label: BETA
  /api/packagingunits/{id}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deletes a single PackagingUnitDetail using its unique identifier.
      operationId: deletePackagingUnitDetail
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted the PackagingUnit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete a PackagingUnitDetail by its ID
      x-fft-permissions:
        - PACKAGING_UNITS_WRITE
      tags:
        - PackagingUnits (DOMS)
      x-badges:
        - color: orange
          label: BETA
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves a single PackagingUnit using its unique identifier.
      operationId: getPackagingUnit
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved the PackagingUnit.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get a PackagingUnits by its ID
      x-fft-permissions:
        - PACKAGING_UNITS_READ
      tags:
        - PackagingUnits (DOMS)
      x-badges:
        - color: orange
          label: BETA
    put:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Updates a single packagingUnitDetail.
      operationId: putPackagingUnitDetail
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackagingUnitDetailForUpdate'
        required: true
      responses:
        '200':
          description: Successfully updated the packagingUnitDetail.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Updates a whole packagingUnitDetail by its ID
      x-fft-permissions:
        - PACKAGING_UNITS_WRITE
      tags:
        - PackagingUnits (DOMS)
      x-badges:
        - color: orange
          label: BETA
  /api/packingcontainertypes:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        all packing container types, use operative container types
      operationId: getPackingContainerTypes
      parameters:
        - description: >-
            Provide the localized values for the entity. If not provided the
            default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
        - description: all entities after given id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PackingContainerType'
                type: array
          description: Found PackingContainerTypes
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List packing container types
      tags:
        - Packing (Operations)
    post:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Add
        a new packing container type, use operative container types.
      operationId: addPackingContainerType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingContainerTypeForCreation'
        description: Packing type object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingContainerType'
          description: >-
            The packing container type was successfully created. The Location
            header contains the URL of the packing container type.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create packing container type
      tags:
        - Packing (Operations)
  /api/packingcontainertypes/{packingContainerTypeId}:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getPackingContainerType
      parameters:
        - description: >-
            Provide the localized values for the entity. If not provided the
            default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
        - description: id of entity
          in: path
          name: packingContainerTypeId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingContainerType'
          description: Found PackingContainerType
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get packing container type
      tags:
        - Packing (Operations)
    patch:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Patches a PackingContainerType with the given ID, use operative
        container types
      operationId: updatePackingContainerType
      parameters:
        - description: ID of the packingcontainertype you want to change
          in: path
          name: packingContainerTypeId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingContainerTypePatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingContainerType'
          description: >-
            PackingContainerType was found & patch-set has been applied. The
            patched PackingContainerType is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: PackingContainerType not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: PackingContainerType version conflict
      summary: Update packing container type
      tags:
        - Packing (Operations)
  /api/packingsourcecontainers:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Listing packingSourceContainer.
      operationId: getPackingSourceContainers
      parameters:
        - description: >-
            Provide the localized values for the entity. If not provided the
            default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
        - description: all entities after given id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            maximum: 500
            type: integer
        - description: filter by packJobRef
          in: query
          name: packJobRef
          required: false
          schema:
            type: string
        - description: filter by facilityRef
          in: query
          name: facilityRef
          required: true
          schema:
            type: string
        - description: filter by scannablecodes
          in: query
          name: codes
          required: false
          schema:
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PaginatedPackingSourceContainers'
                type: array
          description: Found Packing Source Container
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List packing source containers
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creating new packingSourceContainer.
      operationId: addPackingSourceContainer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingSourceContainerForCreation'
        description: Packing type object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingSourceContainer'
          description: >-
            The packing source container  was successfully created. The Location
            header contains the URL of the packing source container.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create packing source container
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/packingsourcecontainers/{packingSourceContainerId}:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        PackingSourceContainer by ID.
      operationId: getPackingSourceContainerById
      parameters:
        - description: ID of the packingSourceContainer
          in: path
          name: packingSourceContainerId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the entity. If not provided the
            default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PackingSourceContainer'
                type: array
          description: Found packingSourceContainer
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get packing source container
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/packjobs:
    get:
      description: ''
      operationId: getPackJobs
      parameters:
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Parameter to filter anonymized pack jobs
          in: query
          name: anonymized
          required: false
          schema:
            type: boolean
        - description: Reference the assigned user on this entity - id or username
          in: query
          name: assignedUser
          required: false
          schema:
            type: string
        - description: Reference to the status you want to get the corresponding packJobs
          explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Reference to the facility you want to get the corresponding packJobs
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: Term by which to search through the fields
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: Reference to the channel you want to get the corresponding packJobs
          in: query
          name: channel
          required: false
          schema:
            enum:
              - COLLECT
              - SHIPPING
            type: string
        - description: filter by packingsourcecontainer containing codes
          in: query
          name: sourceContainerCodes
          required: false
          schema:
            items:
              type: string
            type: array
        - description: query packjobs orderBy
          in: query
          name: orderBy
          required: false
          schema:
            $ref: '#/components/schemas/PackJobOrderBy'
        - description: Start date range for pack jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End date range for pack jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: Reference to the order you want to get the corresponding packJobs
          in: query
          name: orderRef
          required: false
          schema:
            type: string
        - description: Reference to the packJobs you want to get
          in: query
          name: packJobIds
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Reference to the process you want to get the corresponding packJobs
          in: query
          name: processId
          required: false
          schema:
            type: string
        - description: >-
            Reference to the pickJobRef you want to get the corresponding
            packJobs
          in: query
          name: pickJobRef
          required: false
          schema:
            type: string
        - description: Reference to the shortId you want to get the corresponding packJobs
          in: query
          name: shortId
          required: false
          schema:
            type: string
        - description: >-
            Reference to the articleTitle you want to get the corresponding
            packJobs
          in: query
          name: articleTitle
          required: false
          schema:
            type: string
        - description: Start date range of the order for the corresponding pack jobs
          in: query
          name: startOrderDate
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End date range of the order for the corresponding pack jobs
          in: query
          name: endOrderDate
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: >-
            Reference to the username you want to get the corresponding pack
            jobs
          in: query
          name: modifiedByUsername
          required: false
          schema:
            type: string
        - description: >-
            Reference to the tenantOrderId you want to get the corresponding
            packJobs
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJobs'
          description: >-
            Pack jobs was loaded & you were allowed to access it. The result is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: List pack jobs
      tags:
        - Packing (Operations)
    post:
      description: ''
      operationId: addPackJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobForCreation'
        description: Pack job object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJob'
          description: >-
            The pack job was successfully created. The Location header contains
            the URL of the pack job.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create pack job
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}:
    get:
      description: ''
      operationId: getPackJob
      parameters:
        - description: ID of the pack job you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJob'
          description: >-
            Pack job was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack job
      tags:
        - Packing (Operations)
    patch:
      description: ''
      operationId: patchPackJob
      parameters:
        - description: ID of the packjob you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJob'
          description: >-
            PackJob was found & patch-set has been applied. The patched pack job
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: PackJob not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: PackJob version conflict
      summary: Update pack job
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/actions:
    post:
      operationId: packJobAction
      parameters:
        - description: Reference to the pack job you want to call an action for
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJob'
          description: Updated PackJob in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Enitity not found
      summary: Call pack job action
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/deliverynote:
    get:
      description: ''
      operationId: getPackJobDeliveryNote
      parameters:
        - description: ID of the pack job for which you want to get a deliverynote
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The deliverynote for the given packjob
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack job delivery note
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/documenthandling:
    get:
      description: ''
      operationId: getPackJobDocumentHandling
      parameters:
        - description: ID of the pack job you want to get document handling information
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentHandling'
          description: >-
            Pack job document handling was found & you were allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack job document handling
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/returnnote:
    get:
      description: ''
      operationId: getReturnNotesForPackJob
      parameters:
        - description: ID of the PackJob
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: Returns a return note for the packjob.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack job return note
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/targetcontainers:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns all packing containers on given packJob
      operationId: getAllTargetcontainers
      parameters:
        - description: ID of the pack job you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PackingTargetContainer'
          description: >-
            Entity was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: List pack job target containers
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates a new packing target container on given packJob
      operationId: addTargetContainers
      parameters:
        - description: ID of the pack job you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerForCreation'
        description: Packing Container object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: The packing container was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create pack job target container
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}:
    delete:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deletes a packing target container
      operationId: deletePackingTargetContainer
      parameters:
        - description: ID of corresponding packJob you want to patch
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of container you want to delete
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Container was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Delete pack job target container
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns a packing target container with the given ID on given packJob
      operationId: getTargetcontainer
      parameters:
        - description: >-
            Provide the localized values for the entity. If not provided the
            default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
        - description: ID of the pack job you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of the target container you want to get
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: >-
            Entity was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack job target container
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
    patch:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Patches a packing target container
      operationId: patchTargetcontainer
      parameters:
        - description: ID of corresponding packJob you want to patch
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of container you want to patch
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: >-
            Container was found & patch-set has been applied. The patched entity
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update pack job target container
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated. Use /api/packjobs/{packJobId}/actions with
        MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or
        MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead
      operationId: addTargetcontainer
      parameters:
        - description: ID of the pack job you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of the container you want to add new line item to it
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation'
        description: Packing Container line item object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: The packing container was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Add pack job target container line item
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/deliverynote:
    get:
      description: ''
      operationId: getPackingTargetContainerDeliveryNote
      parameters:
        - description: ID of the pack job for which you want to get a deliverynote
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: >-
            ID of the packingTargetContainer for which you want to get a
            deliverynote
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The deliverynote for the given packingTargetContainer
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get target container delivery note
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}:
    delete:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated. Use /api/packjobs/{packJobId}/actions with
        MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or
        MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead
      operationId: deleteLineItemTargetContainers
      parameters:
        - description: ID of corresponding packJob you want to patch
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of container you want to patch
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
        - description: ID of line item you want to patch
          in: path
          name: lineItemId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: LineItem was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Delete target container line item
      tags:
        - Packing (Operations)
    patch:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Patch line item of a packing container
      operationId: patchTargetContainerLineItem
      parameters:
        - description: ID of corresponding packJob you want to patch
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of container you want to patch
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
        - description: ID of line item you want to patch
          in: path
          name: lineItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerActionsParameter'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: >-
            Container was found & patch-set has been applied. The patched entity
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update target container line item
      tags:
        - Packing (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/returnnote:
    get:
      description: ''
      operationId: getReturnNotesForPackingTargetContainer
      parameters:
        - description: ID of the pack job for which you want to get a deliverynote
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: ID of the PackingTargetContainer
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the return note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: Returns a return note for the PackingTargetContainer.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get target container return note
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/transferlabel:
    get:
      description: ''
      operationId: getPackingTargetContainerTransferLabel
      parameters:
        - description: ID of the pack job for which you want to get a transfer label
          in: path
          name: packJobId
          required: true
          schema:
            type: string
        - description: >-
            ID of the packingTargetContainer for which you want to get a
            transfer label
          in: path
          name: targetcontainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The transfer label for the given packingTargetContainer
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get target container transfer label
      tags:
        - Packing (Operations)
  /api/packjobs/{packJobId}/transferlabel:
    get:
      description: ''
      operationId: getPackJobTransferLabel
      parameters:
        - description: ID of the pack job for which you want to get a transfer label
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The transfer label for the given packjob
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pack job transfer label
      tags:
        - Packing (Operations)
  /api/packjobs/search:
    post:
      deprecated: false
      description: Search for PackJob
      operationId: searchPackJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJobPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List pack jobs (search)
      x-fft-permissions:
        - PACKJOB_READ
      tags:
        - Packing (Operations)
  /api/parcelinformation:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns all parcel information that match the given query parameters.
      operationId: getParcelInformation
      parameters:
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            example: 019eefb1-4bd1-7ef0-98ba-f91e07243ea7
            type: string
        - description: number of entities to show. Max value is 500
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: filter by facilityRefs
          in: query
          name: facilityRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: filter by shippingInformationRef
          in: query
          name: shippingInformationRef
          required: false
          schema:
            example: 019eefb2-0001-7000-9000-100000000001
            type: string
        - description: >-
            the value by which results should be ordered by. If nothing is
            passed return values are sorted by id
          in: query
          name: orderBy
          required: false
          schema:
            example: LAST_MODIFIED_DESC
            type: string
        - description: >-
            if set to true, the total count of entities will be returned.
            Default is false
          in: query
          name: withTotal
          required: false
          schema:
            example: true
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelInformationListResponse'
          description: Found parcel information that match the given query parameters.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List parcel information
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Parcel Information (Operations)
      x-badges:
        - color: red
          label: ALPHA
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates a new parcel information.
      operationId: createParcelInformation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelInformationForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelInformation'
          description: Successfully created the parcel information.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create a parcel information
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - Parcel Information (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/parcelinformation/{parcelInformationId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves a single parcel information using its unique identifier.
      operationId: getParcelInformationById
      parameters:
        - in: path
          name: parcelInformationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelInformation'
          description: Successfully retrieved the parcel information.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get a parcel information by its ID
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Parcel Information (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/parcelinformation/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for ParcelInformation
      operationId: searchParcelInformation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelInformationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelInformationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List ParcelInformation (search)
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Parcel Information (Operations)
      x-badges:
        - color: red
          label: ALPHA
  /api/parcels:
    get:
      description: ''
      operationId: getAllParcels
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedParcels'
          description: Parcels are found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List parcels
      tags:
        - Shipments (Operations)
  /api/parcels/{parcelId}:
    get:
      description: ''
      operationId: getParcel
      parameters:
        - description: ID of the parcel you want to get
          in: path
          name: parcelId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: >-
            Parcel was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get parcel
      tags:
        - Shipments (Operations)
    patch:
      description: ''
      operationId: patchParcel
      parameters:
        - description: ID of the parcel you want to get
          in: path
          name: parcelId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: Successfully updated the parcel.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Update parcel
      tags:
        - Shipments (Operations)
  /api/parcels/{parcelId}/actions:
    post:
      description: >-
        Applies actions to a parcel. Check ParcelActionsParameter for available
        actions.
      operationId: parcelAction
      parameters:
        - description: Reference to the parcel you want to call an action for
          in: path
          name: parcelId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: Updated Parcel in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call parcel action
      tags:
        - Shipments (Operations)
  /api/parcels/{parcelId}/deliverynote:
    get:
      operationId: getParcelDeliveryNote
      parameters:
        - description: ID of parcel you want to retrieve deliveryNote for
          in: path
          name: parcelId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DeliveryNote'
          description: Get delivery note as pdf.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Parcel not found
      summary: Get parcel delivery note
      tags:
        - Shipments (Operations)
  /api/parcels/{parcelId}/labels/{labelDocument}:
    get:
      description: ''
      operationId: getLabelForParcel
      parameters:
        - description: ID of the parcel you want to get a label for
          in: path
          name: parcelId
          required: true
          schema:
            type: string
        - description: >-
            Within a parcel different labels can be created. The following types
            of labels are currently supported: return, send and all = Parcel
            label plus (if configured) retoure label.
          in: path
          name: labelDocument
          required: true
          schema:
            $ref: '#/components/schemas/ParcelLabelTypeEnum'
      responses:
        '200':
          content:
            application/pdf: {}
          description: >-
            Parcel was found & you were allowed to access it. The label is in
            the body.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get parcel label
      tags:
        - Shipments (Operations)
  /api/parcels/{parcelId}/returnnote:
    get:
      operationId: getParcelReturnNote
      parameters:
        - description: ID of parcel you want to retrieve returnNote for
          in: path
          name: parcelId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the returnNote. If not provided the
            default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ReturnNote'
          description: Get delivery note as pdf.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Parcel not found
      summary: Get parcel return note
      tags:
        - Shipments (Operations)
  /api/parcels/{parcelId}/transferlabel:
    get:
      description: ''
      operationId: getParcelTransferLabel
      parameters:
        - description: ID of the parcel for which you want to get a transfer label
          in: path
          name: parcelId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The transfer label for the given parcel
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get parcel transfer label
      tags:
        - Shipments (Operations)
  /api/parcels/search:
    post:
      deprecated: false
      description: Search for Parcel
      operationId: searchParcel
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List parcels (search)
      x-fft-permissions:
        - PARCEL_READ
      tags:
        - Shipments (Operations)
  /api/permissions:
    get:
      deprecated: false
      description: This endpoint returns all available permissions in the FFT platform.
      operationId: getPermissions
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: The key of the permission to filter by
          in: query
          name: key
          required: false
          schema:
            enum:
              - USER_READ
              - USERS_READ
              - USER_WRITE
              - USER_MODIFY
              - CURRENT_USER_READ
              - CURRENT_USER_MODIFY
              - ROLE_READ
              - ROLE_WRITE
              - FACILITY_READ
              - FACILITY_WRITE
              - FACILITY_CREATE
              - FACILITY_DELETE
              - FACILITY_GROUP_READ
              - FACILITY_GROUP_WRITE
              - ORDER_READ
              - ORDER_WRITE
              - ORDER_FORCE_CANCEL
              - ORDER_UNLOCK
              - ORDER_CANCEL
              - ORDER_CONSUMER_WRITE
              - ORDER_CUSTOM_ATTRIBUTES_WRITE
              - ORDER_LINEITEM_WRITE
              - ORDER_TOTAL_READ
              - LINE_ITEM_PRICING_READ
              - LINE_ITEM_QUANTITY_INCREASE
              - LINE_ITEM_ADD
              - LINE_ITEM_QUANTITY_DECREASE
              - LINE_ITEM_DELETE
              - SIMULATION_ORDER_READ
              - SIMULATION_ORDER_WRITE
              - AUDIT_READ
              - NOTIFICATION_READ
              - NOTIFICATION_WRITE
              - EXPIRIES_READ
              - EXPIRIES_WRITE
              - CONFIG_READ
              - CONFIG_WRITE
              - ROUTING_CONFIG_READ
              - ROUTING_CONFIG_WRITE
              - PROMISES_CONFIG_READ
              - PROMISES_CONFIG_WRITE
              - OIDC_PROVIDERS_CONFIG_READ
              - OIDC_PROVIDERS_CONFIG_WRITE
              - LOCALE_WRITE
              - CARRIER_READ
              - CARRIER_WRITE
              - RETURN_WRITE
              - RETURN_READ
              - ROUTING_READ
              - ROUTING_WRITE
              - PARCEL_READ
              - PARCEL_WRITE
              - SHIPMENT_READ
              - SHIPMENT_WRITE
              - HANDOVERJOB_READ
              - HANDOVERJOB_WRITE
              - PICKJOB_READ
              - PICKJOB_WRITE
              - PICKJOB_REROUTE
              - REMOTE_CONFIG_READ
              - REMOTE_CONFIG_WRITE
              - PICKRUN_READ
              - PICKRUN_WRITE
              - LOADUNITTYPE_READ
              - LOADUNITTYPE_WRITE
              - LOADUNIT_READ
              - LOADUNIT_WRITE
              - MEASUREMENTUNIT_READ
              - MEASUREMENTUNIT_WRITE
              - EVENT_READ
              - SUBSCRIPTION_READ
              - SUBSCRIPTION_WRITE
              - SUBSTITUTE_READ
              - SUBSTITUTE_WRITE
              - PROCESS_READ
              - PROCESS_WRITE
              - PROCESS_REROUTE
              - EXTERNAL_ACTIONS_READ
              - EXTERNAL_ACTIONS_WRITE
              - PROCESS_LOG_READ
              - OPERATIVE_PROCESS_READ
              - OPERATIVE_PROCESS_WRITE
              - DELIVERYNOTE_WRITE
              - PACKJOB_READ
              - PACKJOB_WRITE
              - PACKINGCONTAINER_TYPE_WRITE
              - PACKING_SOURCE_CONTAINER_READ
              - PACKING_SOURCE_CONTAINER_WRITE
              - RESTOW_ITEM_READ
              - RESTOW_ITEM_WRITE
              - TAG_READ
              - TAG_WRITE
              - STOCK_READ
              - STOCK_WRITE
              - EXTERNAL_STOCK_CHANGE_REASONS_READ
              - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
              - STORAGE_LOCATION_READ
              - STORAGE_LOCATION_WRITE
              - STOW_JOB_READ
              - STOW_JOB_OPERATIVE_WRITE
              - STOW_JOB_FULL_WRITE
              - NOTIFICATION_CENTER_CONFIG_READ
              - NOTIFICATION_CENTER_CONFIG_WRITE
              - DOMS_TOOLKIT_READ
              - DOMS_TOOLKIT_WRITE
              - ANALYTICS_DASHBOARD_READ
              - DOCUMENT_SET_READ
              - DOCUMENT_SET_WRITE
              - INBOUND_PROCESS_READ
              - INBOUND_PROCESS_WRITE
              - ADMIN_DATA_RESET
              - ADMIN_MODULES_READ
              - ADMIN_MODULES_WRITE
              - TENANT_CONNECTOR_CONFIG_READ
              - CUSTOM_SERVICE_WRITE
              - CUSTOM_SERVICE_READ
              - VALIDATIONS_READ
              - SERVICE_JOB_READ
              - SERVICE_JOB_WRITE
              - LINKED_SERVICE_JOBS_READ
              - LINKED_SERVICE_JOBS_WRITE
              - OPERATION_STATISTICS_READ
              - DOMS_STATISTICS_READ
              - AVAILABILITY_CHANNEL_READ
              - AVAILABILITY_CHANNEL_WRITE
              - HANDOVER_CONTAINER_READ
              - HANDOVER_CONTAINER_WRITE
              - STACKS_READ
              - STACKS_WRITE
              - CATEGORY_READ
              - CATEGORY_WRITE
              - PERMISSION_READ
              - KPI_READ
              - AI_ASSISTANT_ACCESS
              - RESERVATION_WRITE
              - RESERVATION_READ
              - FILTER_ENTITY_READ
              - BRAND_READ
              - WORKFLOW_DEFINITION_READ
              - WORKFLOW_DEFINITION_WRITE
              - LOOKUP_RECORD_READ
              - LOOKUP_RECORD_WRITE
              - ORDER_RECORD_READ
              - ORDER_RECORD_WRITE
              - PACKAGING_UNITS_READ
              - PACKAGING_UNITS_WRITE
              - EXPORT_READ
              - EXPORT_WRITE
              - STOCK_AVAILABILITIES_READ
              - LISTING_READ
              - LISTING_WRITE
              - LISTING_DELETE
              - PURCHASE_PRICE_READ
              - ZONE_READ
              - ZONE_WRITE
              - SAFETY_STOCK_READ
              - SAFETY_STOCK_WRITE
            type: string
        - description: The group of the permission to filter by
          in: query
          name: group
          required: false
          schema:
            enum:
              - INVENTORY
              - ORDER_MANAGEMENT
              - SYSTEM_ADMINISTRATION
              - FOUNDATION
              - USER_MANAGEMENT
              - OPERATIONS
              - ADMIN
              - CORE
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionsResponse'
          description: The Permissions
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List permissions
      x-fft-permissions:
        - PERMISSION_READ
      tags:
        - User Management (Core)
  /api/pickjobs:
    get:
      operationId: queryPickJobs
      parameters:
        - description: >-
            Search term you want to get the corresponding pickjobs. Search will
            be performed on multiple fields, like tenantOrderId, consumerName,
            tenantArticleId and more
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: Reference to the carrier you want to get the corresponding pickjobs
          explode: false
          in: query
          name: carrierKeys
          required: false
          schema:
            items:
              maxItems: 100
              type: string
            type: array
        - description: >-
            Reference to the orderDate you want to get the corresponding
            pickjobs
          in: query
          name: startOrderDate
          required: false
          schema:
            type: string
        - description: >-
            Reference to the orderDate you want to get the corresponding
            pickjobs
          in: query
          name: endOrderDate
          required: false
          schema:
            type: string
        - description: Reference to the order you want to get the corresponding pickjobs
          in: query
          name: orderRef
          required: false
          schema:
            type: string
        - description: Reference to the facility you want to get the corresponding pickjobs
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: Reference the assigned user on this entity - id or username
          in: query
          name: assignedUser
          required: false
          schema:
            type: string
        - description: Reference to the status you want to get the corresponding pickjobs
          explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Reference to the zones you want to get the corresponding pickjobs
          explode: false
          in: query
          name: zoneRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the tenantOrderId you want to get the corresponding
            pickjobs
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - description: The channel of the pickJob you want to filter by
          in: query
          name: channel
          required: false
          schema:
            enum:
              - COLLECT
              - SHIPPING
            type: string
        - description: >-
            Reference to the consumer name you want to get the corresponding
            pickjobs
          in: query
          name: consumerName
          required: false
          schema:
            type: string
        - description: Reference to the shortId you want to get the corresponding pickjobs
          in: query
          name: shortId
          required: false
          schema:
            type: string
        - description: >-
            Reference to the articleTitle you want to get the corresponding
            pickjobs
          in: query
          name: articleTitle
          required: false
          schema:
            type: string
        - description: >-
            Reference to the anonymized you want to get the corresponding
            pickjobs
          in: query
          name: anonymized
          required: false
          schema:
            type: boolean
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: query pickjobs orderBy
          in: query
          name: orderBy
          required: false
          schema:
            type: string
        - description: Start date range for pick jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End date range for pick jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: Reference to pickjobs
          explode: false
          in: query
          name: pickJobRefs
          required: false
          schema:
            items:
              maxItems: 100
              type: string
            type: array
        - description: Reference to the user ID you want to get the corresponding pickjobs
          in: query
          name: modifiedByUsername
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedPickJobs'
          description: PickJobs were found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List pick jobs
      tags:
        - Picking (Operations)
    post:
      description: ''
      operationId: addPickJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobForCreation'
        description: Pick job object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJob'
          description: >-
            The pick job was successfully created. The Location header contains
            the URL of the pickjob.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create pick job
      tags:
        - Picking (Operations)
  /api/pickjobs/{pickJobId}:
    get:
      description: ''
      operationId: getPickJob
      parameters:
        - description: ID of the pickjob you want to get
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJob'
          description: >-
            PickJob was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pick job
      tags:
        - Picking (Operations)
    patch:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use POST /api/pickjobs/{pickJobId}/actions instead.
      operationId: patchPickJob
      parameters:
        - description: ID of the pickjob you want to get
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickingPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJob'
          description: >-
            PickJob was found & patch-set has been applied. The patched pick job
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: PickJob not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: PickJob version conflict
      summary: Update pick job
      tags:
        - Picking (Operations)
  /api/pickjobs/{pickJobId}/actions:
    post:
      operationId: pickJobAction
      parameters:
        - description: Reference to the pick job you want to call an action for
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJob'
          description: Updated PickJob in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call pick job action
      tags:
        - Picking (Operations)
  /api/pickjobs/{pickJobId}/deliverynote:
    get:
      description: ''
      operationId: getPickJobDeliveryNote
      parameters:
        - description: ID of the pick job for which you want to get a deliverynote
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The deliverynote for the given pickjob
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pick job delivery note
      tags:
        - Picking (Operations)
  /api/pickjobs/{pickJobId}/documenthandling:
    get:
      description: ''
      operationId: getPickJobDocumentHandling
      parameters:
        - description: ID of the pick job you want to get document handling information
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentHandling'
          description: >-
            Pick job document handling was found & you were allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pick job document handling
      tags:
        - Picking Configuration (Operations)
  /api/pickjobs/{pickJobId}/loadunits:
    get:
      deprecated: false
      description: Get all load units for the given pick job
      operationId: queryPickJobLoadUnits
      parameters:
        - in: path
          name: pickJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnits'
          description: Loadunits were found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List pick job load units
      x-fft-permissions:
        - PICKJOB_READ
        - LOADUNIT_READ
      tags:
        - Picking (Operations)
    post:
      deprecated: false
      description: Create new load units for the given pick job
      operationId: addPickJobLoadUnits
      parameters:
        - in: path
          name: pickJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickingLoadUnitForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnit'
          description: The load units was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create pick job load unit
      x-fft-permissions:
        - PICKJOB_WRITE
        - LOADUNIT_WRITE
      tags:
        - Picking (Operations)
  /api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns all available substitutes for a given pickLineItem.
      operationId: queryPickLineItemsSubstitutes
      parameters:
        - description: Reference to the pick job you to get the available substitutes for
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
        - description: >-
            Reference to the pickLineItem you to get the available substitutes
            for
          in: path
          name: pickLineItemId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResolvedSubstitutes'
          description: Available substitutes for given pickLineItem
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List available line item substitutes
      tags:
        - Picking (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/pickjobs/{pickjobId}/returnnote:
    get:
      description: ''
      operationId: getReturnNotesForPickjob
      parameters:
        - description: ID of the Pickjob
          in: path
          name: pickjobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: Returns a return note for the pickjob.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pick job return note
      tags:
        - Picking (Operations)
  /api/pickjobs/{pickJobId}/transferlabel:
    get:
      description: ''
      operationId: getPickJobTransferLabel
      parameters:
        - description: ID of the pick job for which you want to get a transfer label
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The transfer label for the given pickjob
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get pick job transfer label
      tags:
        - Picking (Operations)
  /api/pickjobs/search:
    post:
      deprecated: false
      description: Search for PickJob
      operationId: searchPickJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJobPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List pick jobs (search)
      x-fft-permissions:
        - PICKJOB_READ
      tags:
        - Picking (Operations)
  /api/pickruns:
    post:
      description: ''
      operationId: addPickRun
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickRun'
          description: >-
            The PickRun was successfully created. The Location header contains
            the URL of it.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
      summary: Create pick run
      tags:
        - Picking (Operations)
  /api/pickruns/{pickRunId}:
    get:
      description: ''
      operationId: getPickRun
      parameters:
        - description: id of pickRun
          in: path
          name: pickRunId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickRun'
          description: PickRun is found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get pick run
      tags:
        - Picking (Operations)
    patch:
      description: ''
      operationId: patchPickRun
      parameters:
        - description: id of pickRun
          in: path
          name: pickRunId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunPatchAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickRun'
          description: The updated PickRun.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Version conflict
      summary: Update pick run
      tags:
        - Picking (Operations)
  /api/pickruns/{pickRunId}/actions:
    post:
      operationId: pickRunAction
      parameters:
        - description: Reference to the pick run you want to call the action for
          in: path
          name: pickRunId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickRun'
          description: Updated Pick Run in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call pick run action
      tags:
        - Picking (Operations)
  /api/pickruns/{pickRunId}/pickjobs:
    patch:
      description: ''
      operationId: patchPickRunPickJobs
      parameters:
        - description: id of pickRun
          in: path
          name: pickRunId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunPickJobsPatchAction'
      responses:
        '200':
          description: Pick job was successfully from pick run removed.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update pick run pick jobs
      tags:
        - Picking (Operations)
  /api/process:
    get:
      description: Get a process by query parameters such as order or pickJob reference
      operationId: getProcess
      parameters:
        - in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - in: query
          name: orderRef
          required: false
          schema:
            type: string
        - in: query
          name: pickJobRef
          required: false
          schema:
            type: string
        - in: query
          name: shipmentRef
          required: false
          schema:
            type: string
        - in: query
          name: handoverJobRef
          required: false
          schema:
            type: string
        - in: query
          name: returnRef
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
          description: Process belonging to the given parameters
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The given parameters are invalid
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get process
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Processes (Core)
  /api/processes:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />No
        longer supported legacy processes endpoint. Please use
        /api/processes/search instead.
      operationId: getAllProcesses
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: Reference to the status you want to get the corresponding processes
          explode: true
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the operativeStatus you want to get the corresponding
            processes
          explode: true
          in: query
          name: operativeStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the trackingStatus you want to get the corresponding
            processes
          explode: true
          in: query
          name: trackingStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Perform full text search based on the tenantOrderId
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - description: Perform full text search based on the consumerId
          in: query
          name: consumerId
          required: false
          schema:
            type: string
        - description: >-
            Return the Processes which have related pickjobs with a targettime
            on or after this date
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: >-
            Return the Processes which have related pickjobs with a targettime
            on or before this date
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: >-
            Return the Processes created on or after this date. If no start date
            is specified, the default is last 30 days.
          in: query
          name: startDate
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: Return the Processes created on or before this date
          in: query
          name: endDate
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: Id's of the facilities from which you want to get the processes
          explode: true
          in: query
          name: facilityRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Id's of the active facilities based on processes from which you want
            to get the processes
          explode: true
          in: query
          name: facilityRefsWithActiveOperations
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Consumer country codes from which you want to get the processes
          explode: true
          in: query
          name: countries
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Facility country codes from which you want to get the processes
          explode: true
          in: query
          name: facilityCountries
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Brand ids for which you want to get the processes
          explode: true
          in: query
          name: brandRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Order delivery preferences service level
          explode: true
          in: query
          name: serviceLevels
          required: false
          schema:
            items:
              enum:
                - DELIVERY
                - SAMEDAY
              type: string
            type: array
        - description: Whether an order is click and collect or delivery
          explode: true
          in: query
          name: serviceTypes
          required: false
          schema:
            items:
              enum:
                - COLLECT
                - SHIPPING
              type: string
            type: array
        - description: >-
            Reference to the orderDomainStatus you want to get the corresponding
            processes
          explode: true
          in: query
          name: orderDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the routingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: routingDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the pickingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: pickingDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the packingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: packingDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the shippingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: shippingDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the handoverDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: handoverDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Reference to the returnDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: returnDomainStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Stickers attached to a order
          explode: true
          in: query
          name: stickers
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Perform full text search over all searchable attributes
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
        - description: SortingParameter name for the query
          in: query
          name: sortBy
          required: false
          schema:
            $ref: '#/components/schemas/SortParameterName'
        - description: Sorting direction for the query
          in: query
          name: sortByDirection
          required: false
          schema:
            $ref: '#/components/schemas/SortDirection'
        - description: '@deprecated Use orderStatus instead'
          in: query
          name: locked
          required: false
          schema:
            type: boolean
        - description: Order status for the query
          in: query
          name: orderStatus
          required: false
          schema:
            $ref: '#/components/schemas/OrderStatus'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Processes'
          description: Process are found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List processes
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Processes (Core)
  /api/processes/{processId}:
    get:
      description: Get a specific process by ID.
      operationId: getProcessByID
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
          description: The found process.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get process
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Processes (Core)
    patch:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, replaced with /api/processes/{processId}/actions
      operationId: patchProcess
      parameters:
        - description: ID of process you want to patch
          in: path
          name: processId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
          description: >-
            Process was found & patch-set has been applied. The patched process
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Process not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Process version conflict
      summary: Update process
      x-fft-permissions:
        - PROCESS_WRITE
      tags:
        - Processes (Core)
  /api/processes/{processId}/actions:
    post:
      description: >-
        Update Process by calling an action. This can be used to trigger state
        transitions or other operations on the process.
      operationId: processAction
      parameters:
        - description: ID of process you want to call the action for
          in: path
          name: processId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
          description: Updated Process in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Process not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Process version conflict
      summary: Call process action
      x-fft-permissions:
        - PROCESS_WRITE
      tags:
        - Processes (Core)
  /api/processes/{processId}/documents:
    post:
      description: Add a document to a process.
      operationId: addDocumentToProcess
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDocumentForCreation'
        description: ''
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDocument'
          description: The document was successfully created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
      summary: Create process document
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Processes (Core)
  /api/processes/{processId}/documents/{documentId}:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        document metadata from a process.
      operationId: readDocumentMetaInProcess
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
        - in: path
          name: documentId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDocument'
          description: >-
            The document meta information with given id attached to the selected
            process
      summary: Get process document
      x-fft-permissions:
        - DOCUMENT_SET_READ
      tags:
        - Processes (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/processes/{processId}/documents/{documentId}/file:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Download a document file from a process.
      operationId: downloadDocumentInProcess
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
        - in: path
          name: documentId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf: {}
          description: The document with given id attached to the selected process
      summary: Download process file
      x-fft-permissions:
        - DOCUMENT_SET_READ
      tags:
        - Processes (Core)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update a document file in a process.
      operationId: updateDocumentInProcess
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
        - in: path
          name: documentId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDocumentForUpdate'
        description: ''
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDocument'
          description: The document was successfully updated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
      summary: Update process file
      x-fft-permissions:
        - DOCUMENT_SET_WRITE
      tags:
        - Processes (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/processes/{processId}/historylogs:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Return all logs for a given process.
      operationId: getProcessHistoryLogs
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
        - description: A type parameter for filtering history logs
          in: query
          name: type
          required: false
          schema:
            type: string
        - description: >-
            Reference to the username you want to get the corresponding history
            logs
          in: query
          name: username
          required: false
          schema:
            type: string
        - description: >-
            Reference to the facility name you want to get the corresponding
            history logs
          in: query
          name: facilityName
          required: false
          schema:
            type: string
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: query process history log orderBy
          in: query
          name: orderBy
          required: false
          schema:
            $ref: '#/components/schemas/ProcessHistoryLogSort'
        - description: control whether you want to filter consecutive duplicate logs
          in: query
          name: filterConsecutiveDuplicates
          required: false
          schema:
            default: true
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessHistoryLogs'
          description: The process logs which were found in response body
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get process history logs
      x-fft-permissions:
        - PROCESS_LOG_READ
      tags:
        - Processes (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/processes/{processId}/reroute:
    post:
      description: Reroute a process to a different facility.
      operationId: rerouteProcess
      parameters:
        - description: ID of process you want to reroute
          in: path
          name: processId
          required: true
          schema:
            type: string
        - description: Version of process you want to reroute
          in: query
          name: version
          required: true
          schema:
            type: number
        - description: The id of the rerouteDescription
          in: query
          name: rerouteDescriptionId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Process'
          description: >-
            Process was found the corresponding reroute operations have been
            triggered.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Process not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Process version conflict
      summary: Create process reroute
      x-fft-permissions:
        - PROCESS_REROUTE
      tags:
        - Processes (Core)
  /api/processes/retrynotroutable:
    post:
      description: Retry routing for all not-routable processes.
      operationId: triggerRetryNotRoutable
      responses:
        '204':
          description: >-
            The retry for all not routable proceses has been succesfully
            triggered
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The retry task can not be triggered due to a conflicting operation
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create retry not routable
      x-fft-permissions:
        - PROCESS_REROUTE
      tags:
        - Processes (Core)
  /api/processes/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Process
      operationId: searchProcess
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List processes (search)
      x-fft-permissions:
        - PROCESS_READ
      tags:
        - Processes (Core)
      x-badges:
        - color: red
          label: ALPHA
  /api/promises/checkoutoptions:
    post:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Evaluate a checkout options input against the DOMS.
      operationId: postCheckoutOptions
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseForCNCCheckoutOptions'
                  - $ref: '#/components/schemas/ResponseForSFSCheckoutOptions'
          description: The request could be evaluated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Create checkout options
      tags:
        - Checkout Options (DOMS)
  /api/promises/checkoutoptions/collect/earliest:
    post:
      deprecated: false
      description: Get earliest collect timepoint for a given checkoutOption
      operationId: checkoutoptionCollectEarliest
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsCollectEarliestRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsCollectEarliestResponse'
          description: The request could be evaluated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Get earliest collect
      tags:
        - Checkout Options (DOMS)
  /api/promises/checkoutoptions/delivery/earliest:
    post:
      deprecated: false
      description: Get earliest delivery timepoint for a given checkoutOption
      operationId: checkoutoptionDeliveryEarliest
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestResponse'
          description: The request could be evaluated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Get earliest delivery
      tags:
        - Checkout Options (DOMS)
  /api/promises/checkoutoptions/delivery/timeperiod:
    post:
      deprecated: false
      description: ''
      operationId: checkoutoptionDeliveryTimePeriod
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponse'
          description: The request could be evaluated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Get delivery time period
      tags:
        - Checkout Options (DOMS)
  /api/promises/checkoutoptions/delivery/timepoint:
    post:
      deprecated: false
      description: >-
        This endpoint is to be used to get information about the possible
        delivery of items.
      operationId: checkoutOptionsTimepoint
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointResponse'
          description: The request could be evaluated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Get delivery timepoint
      tags:
        - Checkout Options (DOMS)
  /api/promises/deliverypromise:
    post:
      description: ''
      operationId: postDeliveryPromise
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromiseRequest'
        description: Order object supplied by your shop instance
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseForDeliveryPromise'
          description: The order promise was created URL of the order promse.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create promise order
      tags:
        - Orders (DOMS)
  /api/purchaseorders:
    post:
      deprecated: false
      description: ''
      operationId: createPurchaseOrder
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOrderForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
          description: Created Purchase Order entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create purchase order
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/purchaseorders/{purchaseOrderId}:
    get:
      deprecated: false
      description: ''
      operationId: getPurchaseOrder
      parameters:
        - in: path
          name: purchaseOrderId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
          description: Purchase Order entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get purchase order
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
    patch:
      deprecated: false
      description: Partially updates a Purchase Order using a selection of fields
      operationId: patchPurchaseOrder
      parameters:
        - in: path
          name: purchaseOrderId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOrderForPartialUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
          description: Updated Purchase Order entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Updates purchase order
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
    put:
      deprecated: false
      description: ''
      operationId: upsertPurchaseOrder
      parameters:
        - in: path
          name: purchaseOrderId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOrderForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
          description: Updated/created Purchase Order entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update purchase order
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/receipts:
    post:
      deprecated: false
      description: ''
      operationId: createReceipt
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReceiptForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
          description: Created inbound receipt
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create receipt
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/receipts/{receiptId}:
    delete:
      deprecated: false
      description: ''
      operationId: deleteReceipt
      parameters:
        - in: path
          name: receiptId
          required: true
          schema:
            type: string
        - in: query
          name: version
          required: true
          schema:
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete receipt
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
    get:
      deprecated: false
      description: ''
      operationId: getReceipt
      parameters:
        - in: path
          name: receiptId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get receipt
      x-fft-permissions:
        - INBOUND_PROCESS_READ
      tags:
        - Inbound (Inventory)
    patch:
      deprecated: false
      description: ''
      operationId: patchReceipt
      parameters:
        - in: path
          name: receiptId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundReceiptForPatch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update receipt
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
    put:
      deprecated: false
      description: ''
      operationId: putReceipt
      parameters:
        - in: path
          name: receiptId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundReceiptForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update receipt
      x-fft-permissions:
        - INBOUND_PROCESS_WRITE
      tags:
        - Inbound (Inventory)
  /api/remoteconfigs:
    get:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated: Use /api/remoteconfigurations/search instead
      operationId: getAllRemoteConfigurations
      parameters:
        - description: Number of results to return (max 500)
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            type: number
        - description: Cursor for pagination - ID to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Filter by group(s)
          in: query
          name: groups
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Filter by facility ID
          in: query
          name: facilityId
          required: false
          schema:
            type: string
        - description: Filter by user ID
          in: query
          name: userId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfigurations'
          description: Central RemoteConfiguration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List remote configs
      x-fft-permissions:
        - REMOTE_CONFIG_READ
      tags:
        - Remote Configs (Core)
    post:
      deprecated: false
      description: >-
        Create a new remote configuration with specified key, value, type,
        groups, and optional scopes.
      operationId: createRemoteConfiguration
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationForCreation'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Created entity in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create remote config
      x-fft-permissions:
        - REMOTE_CONFIG_WRITE
      tags:
        - Remote Configs (Core)
  /api/remoteconfigs/{id}:
    delete:
      deprecated: false
      description: >-
        Delete a remote configuration by its unique identifier. This operation
        is irreversible. Also accepts key in URN format (e.g.
        urn:fft:remoteconfig:key:{your-key}).
      operationId: deleteRemoteConfiguration
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully Deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete remote config
      x-fft-permissions:
        - REMOTE_CONFIG_WRITE
      tags:
        - Remote Configs (Core)
    get:
      deprecated: false
      description: >-
        Get a single remote configuration by its unique identifier. Also accepts
        key in URN format (e.g. urn:fft:remoteconfig:key:{your-key}).
      operationId: getRemoteConfiguration
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Central RemoteConfiguration
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get remote config
      x-fft-permissions:
        - REMOTE_CONFIG_READ
      tags:
        - Remote Configs (Core)
    patch:
      deprecated: false
      description: >-
        Update an existing remote configuration by its unique identifier. Only
        provided fields will be updated, others will remain unchanged. Also
        accepts key in URN format (e.g. urn:fft:remoteconfig:key:{your-key}).
      operationId: updateRemoteConfiguration
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Successfully Changed
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update remote config
      x-fft-permissions:
        - REMOTE_CONFIG_WRITE
      tags:
        - Remote Configs (Core)
    put:
      deprecated: false
      description: >-
        Replace an existing remote configuration by its unique identifier. All
        fields will be replaced with the provided values. Also accepts key in
        URN format (e.g. urn:fft:remoteconfig:key:{your-key}).
      operationId: putRemoteConfiguration
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationForPut'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Successfully Changed
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update remote config
      x-fft-permissions:
        - REMOTE_CONFIG_WRITE
      tags:
        - Remote Configs (Core)
  /api/remoteconfigs/{id}/scopes:
    post:
      deprecated: false
      description: >-
        Add a new scope to an existing remote configuration. The scope will be
        added to the list of existing scopes. Also accepts key in URN format
        (e.g. urn:fft:remoteconfig:key:{your-key}).
      operationId: addRemoteConfigurationScope
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRemoteConfigurationScopeParameter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Updated RemoteConfiguration in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create remote config scope
      x-fft-permissions:
        - REMOTE_CONFIG_WRITE
      tags:
        - Remote Configs (Core)
  /api/remoteconfigs/{id}/scopes/{scopeId}:
    delete:
      deprecated: false
      description: >-
        Remove a scope from an existing remote configuration by scope ID. The
        scope will be removed from the list of existing scopes. Also accepts key
        in URN format (e.g. urn:fft:remoteconfig:key:{your-key}).
      operationId: deleteScopeFromRemoteConfiguration
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - in: path
          name: scopeId
          required: true
          schema:
            type: string
        - description: Version of the remote config for optimistic locking
          in: query
          name: version
          required: true
          schema:
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Successfully Deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete remote config scope
      x-fft-permissions:
        - REMOTE_CONFIG_WRITE
      tags:
        - Remote Configs (Core)
  /api/remoteconfigurations/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for RemoteConfiguration
      operationId: searchRemoteConfiguration
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfigurationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List remote configurations (search)
      x-fft-permissions:
        - REMOTE_CONFIG_READ
      tags:
        - Configurations (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/reroutedescriptions:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getRerouteDescriptions
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteDescriptions'
          description: >-
            RerouteDescription were found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: User not found
      summary: List reroute descriptions
      tags:
        - Routing Plans (DOMS)
      x-badges:
        - color: orange
          label: BETA
    post:
      operationId: postRerouteDescription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerouteDescriptionForCreation'
        description: The RerouteDescription
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteDescription'
          description: >-
            The RerouteDescription has been successfully created. The Location
            header includes the URL of the document.
        '303':
          description: >-
            The RerouteDescription already exists. The Location header contains
            the URL of the document.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create reroute description
      tags:
        - Routing Plans (DOMS)
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      x-badges:
        - color: orange
          label: BETA
  /api/reroutedescriptions/{rerouteDescriptionId}:
    delete:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: deleteRerouteDescription
      parameters:
        - description: ID of the reroute description you intend to delete
          in: path
          name: rerouteDescriptionId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            The reroute description was found, and you have been granted
            permission to delete it.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: RerouteDescription not found
      summary: Delete reroute description
      tags:
        - Routing Plans Configuration (DOMS)
      x-badges:
        - color: orange
          label: BETA
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getRerouteDescriptionById
      parameters:
        - description: Id of the reroute description you wish to retrieve
          in: path
          name: rerouteDescriptionId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteDescription'
          description: >-
            RerouteDescription was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: User not found
      summary: Get reroute description
      tags:
        - Routing Plans Configuration (DOMS)
      x-badges:
        - color: orange
          label: BETA
    put:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: putRerouteDescription
      parameters:
        - description: ID of the reroute description you intend to modify
          in: path
          name: rerouteDescriptionId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerouteDescriptionForModification'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteDescription'
          description: >-
            RerouteDescription rating was found & you were allowed to access it.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: RerouteDescription not found
      summary: Update reroute description
      tags:
        - Routing Plans Configuration (DOMS)
      x-badges:
        - color: orange
          label: BETA
  /api/reservations:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getPaginatedReservations
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - description: >-
            The cursor to start after. The value is provided in the
            `pageInfo.endCursor` field of the response.
          in: query
          name: after
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservationsPaginatedResult'
          description: Reservation details
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List reservations
      x-fft-permissions:
        - RESERVATION_READ
      tags:
        - Reservations (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/reservations/{reservationId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getReservation
      parameters:
        - in: path
          name: reservationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Reservation'
          description: Reservation details
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get reservation
      x-fft-permissions:
        - RESERVATION_READ
      tags:
        - Reservations (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/reservations/actions:
    post:
      deprecated: false
      description: >
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />REMOVE_RESERVATIONS_KEEP_STOCKS: Removes reservations without
        modifying stock levels.

              REMOVE_RESERVATIONS_AND_REDUCE_STOCKS:  Removes reservations and reduces stock levels accordingly.
      operationId: performReservationActions
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReservationAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ReservationActionResult'
                type: array
          description: List of reservation removal results with stock operations
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call reservations action
      x-fft-permissions:
        - RESERVATION_WRITE
      tags:
        - Reservations (Inventory)
      x-badges:
        - color: red
          label: ALPHA
  /api/reservations/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Reservation
      operationId: searchReservation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReservationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReservationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List reservations (search)
      x-fft-permissions:
        - RESERVATION_READ
      tags:
        - Reservations (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/restowitems:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: queryRestowItems
      parameters:
        - description: Reference to the facility you want to get the corresponding restows
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: Reference restowed status of the restow items
          in: query
          name: restowed
          required: false
          schema:
            type: boolean
        - description: Reference status of the restow items
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: query orderBy
          in: query
          name: orderBy
          required: false
          schema:
            $ref: '#/components/schemas/RestowItemsSortOptionsEnum'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestowedItems'
          description: Restow items were found. The results are in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List restow items
      tags:
        - Restowing (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/restowitems/{restowItemId}:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getRestowItem
      parameters:
        - description: ID of the restow item you want to get
          in: path
          name: restowItemId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestowItem'
          description: >-
            RestowItem was found & you were allowed to access it. The result is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get restow item
      tags:
        - Restowing (Operations)
      x-badges:
        - color: orange
          label: BETA
    patch:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated, please use /api/restowitems/{restowItemId}/actions
      operationId: patchRestowItem
      parameters:
        - description: ID of the restow item you want to update
          in: path
          name: restowItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestowItemPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestowItem'
          description: >-
            RestowItem was found & patch-set has been applied. The patched
            restow item is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: RestowItem not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: RestowItem version conflict
      summary: Update restow item
      tags:
        - Restowing (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/restowitems/{restowItemId}/actions:
    post:
      operationId: restowItemAction
      parameters:
        - description: Reference to the restow item you want to call an action for
          in: path
          name: restowItemId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestowItemActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestowItem'
          description: Updated RestowItem in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The entity you want to call an action for was not found.
      summary: Call restow item action
      tags:
        - Restowing (Operations)
  /api/returnnotes:
    post:
      operationId: createReturnNote
      parameters:
        - description: >-
            Provide the localized values for the return note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnNote'
        required: true
      responses:
        '201':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ReturnNote'
          description: Successfully created the return note.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create return note
      tags:
        - Shipments (Operations)
  /api/roles:
    get:
      deprecated: false
      description: >-
        Returns all existing roles, including their permissions and context
        ceilings.
      operationId: getAllRoles
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Role'
                type: array
          description: The requested roles.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List roles
      x-fft-permissions:
        - ROLE_READ
      tags:
        - User Management (Core)
    post:
      deprecated: false
      description: Creates a new custom role.
      operationId: createRole
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: The created role.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create role
      x-fft-permissions:
        - ROLE_WRITE
      tags:
        - User Management (Core)
  /api/roles/{name}:
    delete:
      deprecated: false
      description: Deletes an existing role.
      operationId: deleteRole
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: The deleted role.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete role
      x-fft-permissions:
        - ROLE_WRITE
      tags:
        - User Management (Core)
    get:
      deprecated: false
      description: Returns a role requested by its name.
      operationId: getRole
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: The requested role.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Return role
      x-fft-permissions:
        - ROLE_READ
      tags:
        - User Management (Core)
    patch:
      deprecated: false
      description: Updates an existing role (partial update).
      operationId: patchRole
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleForPatch'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: The patched role, including all the updates made.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update role
      x-fft-permissions:
        - ROLE_WRITE
      tags:
        - User Management (Core)
    put:
      deprecated: false
      description: Updates an existing role (complete replacement).
      operationId: updateRole
      parameters:
        - in: path
          name: name
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
          description: The updated role, including all the updates made.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update role
      x-fft-permissions:
        - ROLE_WRITE
      tags:
        - User Management (Core)
  /api/roles/search:
    post:
      deprecated: false
      description: Search for Role
      operationId: searchRole
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RolePaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List roles (search)
      x-fft-permissions:
        - ROLE_READ
      tags:
        - User Management (Core)
  /api/routing/commands/reroute:
    post:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: reRoute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerouteRoutingPlan'
        description: >-
          An object, that can contain either lists of identifiers for which a
          reroute should be executed or an option to reroute every reroutable
          plan.
        required: true
      responses:
        '200':
          description: Rerouting was successfully triggered
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Trigger reroute
      tags:
        - Routing Plans (DOMS)
      x-badges:
        - color: orange
          label: BETA
  /api/routing/decisionlogs:
    get:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getRoutingDecisionLogs
      parameters:
        - description: All decision logs for given sourcingOptionRef
          in: query
          name: sourcingOptionRef
          required: false
          schema:
            type: string
        - description: All decision logs for given processRef
          in: query
          name: processRef
          required: false
          schema:
            type: string
        - description: All decision logs for given orderRef
          in: query
          name: orderRef
          required: false
          schema:
            type: string
        - description: All decision logs for given routingPlanRef
          in: query
          name: routingPlanRef
          required: false
          schema:
            type: string
        - description: All decision logs for given sourcingOptionsRef
          in: query
          name: sourcingOptionsRef
          required: false
          schema:
            type: string
        - description: All decision logs for given tenantOrderId
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - description: All decision logs after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Number of decision logs to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            maximum: 500
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingDecisionLogs'
          description: >-
            Decision logs were found & you were allowed to access them. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get routing decision logs
      tags:
        - Routing Strategy (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/routing/journals:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns a paginated list of routing journal entries filtered by
        processRef.
      operationId: listRoutingJournals
      parameters:
        - in: query
          name: processRef
          required: false
          schema:
            type: string
        - in: query
          name: orderRef
          required: false
          schema:
            type: string
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingJournals'
          description: Successfully retrieved the routing journal entries.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List routing journal entries by processRef
      x-fft-permissions:
        - ROUTING_READ
      tags:
        - RoutingJournal (doms)
      x-badges:
        - color: red
          label: ALPHA
  /api/routing/journals/{id}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves a single routingJournal using its unique identifier.
      operationId: getRoutingJournalById
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingJournal'
          description: Successfully retrieved the routingJournal.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get a routingJournal by its ID
      x-fft-permissions:
        - ROUTING_READ
      tags:
        - RoutingJournal (doms)
      x-badges:
        - color: red
          label: ALPHA
  /api/routing/nodeconfigcategories:
    get:
      description: List all the categories for node configurations.
      operationId: getRoutingStrategyNodeConfigCategories
      parameters:
        - description: All entities
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RoutingStrategyNodeConfigCategoryTransporter
          description: The current list of available categories
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No more elements available
      summary: List category node configuration
      tags:
        - Routing Strategy (DOMS)
    post:
      description: Creates a new category for a routing strategies node config.
      operationId: postRoutingStrategyNodeConfigCategory
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/RoutingStrategyNodeConfigCategoryForCreation
        description: The desired category
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RoutingStrategyNodeConfigCategoryForResponse
          description: The created routing strategy.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create category node configuration
      tags:
        - Routing Strategy (DOMS)
  /api/routing/nodeconfigcategories/{categoryId}:
    delete:
      description: Deletes the category
      operationId: deleteRoutingStrategyNodeConfigCategory
      parameters:
        - description: ID of the category you want to delete
          in: path
          name: categoryId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The category has been deleted.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Delete category node configuration
      tags:
        - Routing Strategy (DOMS)
    get:
      description: Returns the category
      operationId: getRoutingStrategyNodeConfigCategory
      parameters:
        - description: ID of the category you wish to retrieve
          in: path
          name: categoryId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RoutingStrategyNodeConfigCategoryForResponse
          description: The returned category.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See the response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Returns category node configuration
      tags:
        - Routing Strategy (DOMS)
    put:
      description: Updates a category
      operationId: putRoutingStrategyNodeConfigCategory
      parameters:
        - description: ID of the category you wish to update
          in: path
          name: categoryId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/RoutingStrategyNodeConfigCategoryForModification
        description: The updated category
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/RoutingStrategyNodeConfigCategoryForResponse
          description: The updated category.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Updates category node configuration
      tags:
        - Routing Strategy (DOMS)
  /api/routing/sourcingoptions:
    post:
      operationId: createSourcingOptionsRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourcingOptionsRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcingOptionsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/SourcingOptionsResponse'
          description: Sourcing option successfully created
        '400':
          description: Validation exception
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create sourcing option
      tags:
        - Sourcing Options (DOMS)
  /api/routing/sourcingoptions/{sourcingOptionsRequestId}:
    get:
      operationId: getSourcingOption
      parameters:
        - description: ID of the sourcing option request
          in: path
          name: sourcingOptionsRequestId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcingOptionsResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/SourcingOptionsResponse'
          description: Sourcing options successfully created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get sourcing option
      tags:
        - Sourcing Options (DOMS)
  /api/routing/strategies:
    get:
      description: List all existing routing strategies
      operationId: getRoutingStrategies
      parameters:
        - description: All entities
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategyTransporter'
          description: The current list of available routing strategies
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No more elements available
      summary: List routing strategies
      tags:
        - Routing Strategy (DOMS)
    post:
      description: Creates a new revision of the routing strategy.
      operationId: postRoutingStrategy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingStrategyForCreation'
        description: The desired routing strategy
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategy'
          description: The created routing strategy.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See the response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create routing strategy
      tags:
        - Routing Strategy (DOMS)
  /api/routing/strategies/{strategyId}:
    get:
      description: Returns the routing strategy.
      operationId: getRoutingStrategy
      parameters:
        - description: ID of the routing strategy you wish to retrieve
          in: path
          name: strategyId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategy'
          description: The returned routing strategy.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get routing strategy
      tags:
        - Routing Strategy (DOMS)
    put:
      description: Updates a routing strategy
      operationId: putRoutingStrategy
      parameters:
        - description: Id of the routing strategy you wish to update
          in: path
          name: strategyId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingStrategyForModification'
        description: The updated routing strategy
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategy'
          description: The updated routing strategy.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update routing strategy
      tags:
        - Routing Strategy (DOMS)
  /api/routing/strategies/{strategyId}/actions:
    post:
      description: Performs an action on a routing strategy.
      operationId: actionsRoutingStrategy
      parameters:
        - description: Id of the routing strategy
          in: path
          name: strategyId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingStrategyActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategy'
          description: The updated routing strategy.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call routing strategy action
      tags:
        - Routing Strategy (DOMS)
  /api/routing/strategies/{strategyId}/evaluation:
    post:
      description: Evaluates a routing strategy against a given order
      operationId: evaluateRoutingStrategy
      parameters:
        - description: Id of the routing strategy
          in: path
          name: strategyId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategyEvaluationResult'
          description: The result of the evaluation of the routing strategy.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The routing strategy does not exist
      summary: Evaluate routing strategy
      tags:
        - Routing Strategy (DOMS)
  /api/routing/strategies/{strategyId}/nodes/{nodeId}/evaluation:
    post:
      description: Evaluates a routing strategy node and return the path.
      operationId: evaluateRoutingStrategyNode
      parameters:
        - description: Id of the routing strategy
          in: path
          name: strategyId
          required: true
          schema:
            type: string
        - description: Id of the node
          in: path
          name: nodeId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingStrategyEvaluationResult'
          description: The result of the evaluation of this routing strategy node.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The routing strategy node does not exist
      summary: Evaluate routing strategy node
      tags:
        - Routing Strategy (DOMS)
  /api/routingplans:
    get:
      description: ''
      operationId: getRoutingPlanBaseOnOrderRef
      parameters:
        - description: >-
            Reference to the order you want to get the corresponding routing
            plan.
          in: query
          name: orderRef
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingPlans'
          description: >-
            Routing plan was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found, please look at details.
      summary: List routing plans
      tags:
        - Routing Plans (DOMS)
  /api/routingplans/{routingplanId}:
    get:
      description: ''
      operationId: getRoutingPlan
      parameters:
        - description: ID of the routing plan want to get
          in: path
          name: routingplanId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingPlan'
          description: >-
            Routing plan was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Not found, please look at details.
      summary: Get routing plan
      tags:
        - Routing Plans (DOMS)
    patch:
      description: ''
      operationId: patchRoutingPlan
      parameters:
        - description: ID of routing plan you want to patch
          in: path
          name: routingplanId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingPlanPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingPlan'
          description: >-
            Routing plan was found & patch-set has been applied. The patched
            entity is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found, for more information please look at details.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update routing plan
      tags:
        - Routing Plans (DOMS)
  /api/routingplans/{routingplanId}/decisionlogs/{routingRun}:
    get:
      description: ''
      operationId: getDecisionlog
      parameters:
        - description: ID of the routing plan you want to get it's decision log
          in: path
          name: routingplanId
          required: true
          schema:
            type: string
        - description: ID of the decision log you want to get
          in: path
          name: routingRun
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecisionLog'
          description: Decision log was found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Decision log not found
      summary: List routing plan decision log
      tags:
        - Routing Plans (DOMS)
  /api/routingplans/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for RoutingPlan
      operationId: searchRoutingPlan
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingPlanSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingPlanPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List routing plans (search)
      x-fft-permissions:
        - ROUTING_READ
      tags:
        - Routing Plans (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/routingplansgraph:
    get:
      description: ''
      operationId: getRoutingPlansGraphBaseOnProcessRef
      parameters:
        - description: >-
            Reference to the process you want to get the corresponding routing
            plans graph.
          in: query
          name: processRef
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingPlansGraph'
          description: >-
            Routing plans graph was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found, please look at details.
      summary: List routing plans graphs
      tags:
        - Routing Plans (DOMS)
  /api/safetystocks:
    get:
      deprecated: false
      description: ''
      operationId: getSafetyStocks
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: tenantArticleId
          required: false
          schema:
            type: string
        - in: query
          name: facilityRef
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafetyStocksPaginatedResult'
          description: Available Safety Stocks
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List safety stocks
      x-fft-permissions:
        - SAFETY_STOCK_READ
      tags:
        - Stocks (Inventory)
    put:
      deprecated: false
      description: ''
      operationId: bulkUpdateSafetyStock
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SafetyStockBulkOperations'
        required: true
      responses:
        '207':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafetyStockBulkOperationResult'
          description: Result of the bulk operations
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update safety stocks
      x-fft-permissions:
        - SAFETY_STOCK_WRITE
      tags:
        - Stocks (Inventory)
  /api/safetystocks/{safetyStockId}:
    delete:
      deprecated: false
      description: ''
      operationId: deleteSafetyStock
      parameters:
        - in: path
          name: safetyStockId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Result of the bulk operations
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete safety stock
      x-fft-permissions:
        - SAFETY_STOCK_WRITE
      tags:
        - Stocks (Inventory)
  /api/scopedcapabilities:
    get:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getCapabilities
      parameters:
        - description: id of the facility
          in: query
          name: facilityId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ScopedCapability'
          description: All ScopedCapabilities which are at least inactive
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: List scoped capabilities
      tags:
        - Features (Infrastructure)
      x-badges:
        - color: orange
          label: BETA
  /api/servicecontainers:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Gets
        service containers filtered
      operationId: getServiceContainers
      parameters:
        - description: number of entities to show
          in: query
          name: size
          required: true
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
            minLength: 1
            type: string
        - description: sorting for the results
          in: query
          name: orderBy
          required: false
          schema:
            enum:
              - SERVICE_CONTAINER_LAST_MODIFIED_ASC
              - SERVICE_CONTAINER_LAST_MODIFIED_DESC
              - SERVICE_CONTAINER_CREATED_ASC
              - SERVICE_CONTAINER_CREATED_DESC
            example: CREATED_DESC
            type: string
        - description: Reference of the facility you want to filter for
          in: query
          name: facilityRefs
          required: false
          schema:
            example:
              - ba095e30-879f-11ee-b9d1-0242ac120002
            items:
              type: string
            maxItems: 50
            type: array
        - description: Reference of the service job you want to filter for
          in: query
          name: serviceJobRef
          required: false
          schema:
            example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
            minLength: 1
            type: string
        - description: >-
            The statuses you want to filter the service containers by. If not
            provided, only service containers in status AVAILABLE will be
            returned. An empty array will return all service containers
            regardless of status.
          in: query
          name: statuses
          required: false
          schema:
            example: '[AVAILABLE]'
            items:
              enum:
                - AVAILABLE
                - OBSOLETE
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceContainers'
          description: Service containers can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List service containers
      x-fft-permissions:
        - SERVICE_JOB_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates a service container
      operationId: createServiceContainer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceContainerForCreation'
        description: Desired service container to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceContainer'
          description: The service container was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create service container
      x-fft-permissions:
        - SERVICE_JOB_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicecontainers/{serviceContainerId}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deletes service container by id
      operationId: deleteServiceContainer
      parameters:
        - description: ID of the service container to delete
          in: path
          name: serviceContainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The service container has successfully been set to OBSOLETE.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Soft deletes service container by id by setting them to status OBSOLETE.
      x-fft-permissions:
        - SERVICE_JOB_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Gets
        service container by id
      operationId: getServiceContainerById
      parameters:
        - description: ID of the service container to retrieve
          in: path
          name: serviceContainerId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceContainer'
          description: Service container for the given id.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get service container by id
      x-fft-permissions:
        - SERVICE_JOB_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicejobs:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />List
        service jobs
      operationId: getServiceJobs
      parameters:
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
            minLength: 1
            type: string
        - description: Reference of the facility you want to filter for
          in: query
          name: facilityRef
          required: false
          schema:
            example: 6027cece-93b8-4628-9314-a3f455af9e46
            minLength: 1
            type: string
        - description: >-
            Reference to the statuses you want to get the corresponding service
            job
          in: query
          name: status
          required: false
          schema:
            example: OPEN
            items:
              enum:
                - OPEN
                - IN_PROGRESS
                - FINISHED
                - CANCELLED
                - WAITING_FOR_INPUT
                - OBSOLETE
                - NOT_READY
              type: string
            maxItems: 10
            type: array
        - description: Type of channel you want to filter for
          in: query
          name: channel
          required: false
          schema:
            enum:
              - COLLECT
              - SHIPPING
            example: COLLECT
            type: string
        - description: Start target date range for service jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End target date range for service jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: Order in which the result should be returned
          in: query
          name: orderBy
          required: false
          schema:
            enum:
              - TARGET_TIME_ASC
              - TARGET_TIME_DESC
              - LAST_MODIFIED_ASC
              - LAST_MODIFIED_DESC
            example: TARGET_TIME_ASC
            type: string
        - description: >-
            Search term you want to get the corresponding service jobs. Search
            will be performed on multiple fields, like tenantOrderId,
            consumerName, tenantArticleId and more
          in: query
          name: searchTerm
          required: false
          schema:
            example: John Doe
            minLength: 1
            type: string
        - description: Reference the assigned user on this entity - id or username
          in: query
          name: assignedUser
          required: false
          schema:
            example: USER_ID
            minLength: 1
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJobs'
          description: Service Jobs can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List service jobs
      x-fft-permissions:
        - SERVICE_JOB_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create service job
      operationId: createServiceJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobForCreation'
        description: Desired service job to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJob'
          description: The service job was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create service job
      x-fft-permissions:
        - SERVICE_JOB_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicejobs/{serviceJobId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        service job
      operationId: getServiceJob
      parameters:
        - description: ID of service job you want to get
          in: path
          name: serviceJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJob'
          description: Service Job can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get service job
      x-fft-permissions:
        - SERVICE_JOB_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicejobs/{serviceJobId}/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Apply an action to a service job.
      operationId: updateServiceJob
      parameters:
        - description: ID of service job you want to update
          in: path
          name: serviceJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/ServiceJobInProgressActionParameter'
                - $ref: '#/components/schemas/ServiceJobFinishedActionParameter'
                - $ref: '#/components/schemas/ServiceJobCancelledActionParameter'
                - $ref: >-
                    #/components/schemas/ServiceJobWaitingForInputActionParameter
                - $ref: '#/components/schemas/ServiceJobOpenActionParameter'
                - $ref: '#/components/schemas/ServiceJobObsoleteActionParameter'
                - $ref: >-
                    #/components/schemas/ServiceJobReplaceAssignedUsersActionParameter
                - $ref: '#/components/schemas/ServiceJobSplitLineItemsActionParameter'
                - $ref: >-
                    #/components/schemas/UpdateServiceJobLineItemRecordableAttributesActionParameter
                - $ref: '#/components/schemas/ServiceJobAddTargetTimeActionParameter'
        description: Desired change to a service job
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJob'
          description: The service job was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call service job action
      x-fft-permissions:
        - SERVICE_JOB_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicejobs/{serviceJobId}/servicecontainers:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Lists service containers by the id of the related service job
      operationId: getServiceContainersByServiceJobId
      parameters:
        - description: ID of the service job to retrieve containers for
          in: path
          name: serviceJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ServiceContainer'
                type: array
          description: Service containers for the given service job.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List service containers for a service job
      x-fft-permissions:
        - SERVICE_JOB_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicejobs/{serviceJobId}/servicedata:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        the service data of the referenced service job.
      operationId: getServiceData
      parameters:
        - description: ID of service job referenced by the service data you want to get
          in: path
          name: serviceJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceData'
          description: Service Data can be found in response body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get service data
      x-fft-permissions:
        - SERVICE_JOB_READ
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/servicejobs/{serviceJobId}/servicedata/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Apply an action to the service data of the referenced service job.
      operationId: updateServiceData
      parameters:
        - description: ID of service job referenced by the service data you want to update
          in: path
          name: serviceJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/ServiceItemSelectQuantityActionParameter
                - $ref: >-
                    #/components/schemas/ServiceItemUnselectQuantityActionParameter
                - $ref: >-
                    #/components/schemas/AddServiceDataAvailableLineItemsActionParameter
                - $ref: >-
                    #/components/schemas/RemoveServiceDataAvailableLineItemsActionParameter
                - $ref: >-
                    #/components/schemas/UpdateServiceDataAvailableLineItemsActionParameter
        description: Desired change to service data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceData'
          description: The service data was successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call service data action
      x-fft-permissions:
        - SERVICE_JOB_WRITE
      tags:
        - Services (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/shipments:
    get:
      description: ''
      operationId: getAllShipments
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: This query can be used to find shipments for a referenced pickjob
          in: query
          name: pickJobRef
          required: false
          schema:
            type: string
        - description: >-
            This query can be used to find shipments belonging to the referenced
            facility
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: This query can be used to find shipments for a referenced carrier
          in: query
          name: carrierRef
          required: false
          schema:
            type: string
        - description: >-
            This query can be used to find shipments with the given
            tenantOrderId
          in: query
          name: tenantOrderId
          required: false
          schema:
            type: string
        - description: Find shipments with one the the given carriers
          explode: false
          in: query
          name: carrierKeys
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Find shipments in one of the given status
          explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Find shipments with parcels in one of the given status
          explode: false
          in: query
          name: parcelStatus
          required: false
          schema:
            items:
              type: string
            type: array
        - description: Start date range for shipments
          in: query
          name: startTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: End date range for shipments
          in: query
          name: endTargetTime
          required: false
          schema:
            example: 2020-02-03T08:45:50.525Z
            format: date-time
            type: string
        - description: Parameter to filter anonymized shipments
          in: query
          name: anonymized
          required: false
          schema:
            type: boolean
        - description: >-
            Fulltext search in shipment's tenantOrderId, shortId,
            parcels.carrierTrackingNumber, lineItems.article.tenantArticleId,
            lineItems.article.title, invoiceAddress, targetAddress and
            customerName
          in: query
          name: searchTerm
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedShipments'
          description: Shipments are found.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List shipments
      tags:
        - Shipments (Operations)
    post:
      operationId: addShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentForCreation'
        description: Shipment object supplied by your picking app
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipment'
          description: >-
            The Shipment was successfully created. The Location header contains
            the URL of the Shipment.
        '303':
          description: >-
            The Shipment already exists. The Location header contains the URL of
            the Shipment.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create shipment
      tags:
        - Shipments (Operations)
  /api/shipments/{shipmentId}:
    get:
      description: ''
      operationId: getShipment
      parameters:
        - description: ID of Shipment you want to get
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipment'
          description: >-
            Shipment was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Shipment not found
      summary: Get shipment
      tags:
        - Shipments (Operations)
    patch:
      description: ''
      operationId: patchShipment
      parameters:
        - description: ID of shipment you want to patch
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentPatchActions'
        description: Patch set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipment'
          description: >-
            Shipment was found & patch-set has been applied. The patched entity
            is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      summary: Update shipment
      tags:
        - Shipments (Operations)
  /api/shipments/{shipmentId}/actions:
    post:
      operationId: shipmentActions
      parameters:
        - description: Reference to the shipment you want to call an action for
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Shipment'
          description: Updated Shipment in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call shipment action
      tags:
        - Shipments (Operations)
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      x-badges:
        - color: orange
          label: BETA
  /api/shipments/{shipmentId}/deliverynote:
    get:
      operationId: getShipmentDeliveryNote
      parameters:
        - description: ID of shipment you want to retrieve delivery note for
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized values for the delivery note. If not provided
            the default locale is used. For example de_DE.
          in: query
          name: locale
          schema:
            type: string
      responses:
        '200':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DeliveryNote'
          description: Get delivery note as pdf.
        '401':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Shipment not found
      summary: Get shipment delivery note
      tags:
        - Shipments (Operations)
  /api/shipments/{shipmentId}/parcels:
    post:
      description: ''
      operationId: addParcel
      parameters:
        - description: ID of shipment you want to create parcel for
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelForCreation'
        description: Payload of the parcel you want to create
        required: false
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: >-
            The Parcel was successfully created. The Location header contains
            the URL of the Shipment.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Parcel could not be processed due to failing conditions
      summary: Create shipment parcel
      tags:
        - Shipments (Operations)
  /api/shipments/parcels:
    post:
      description: >-
        This endpoints directly creates a parcel. If no ShipmentRef was
        provided, a shipment will be created and linked to this parcel
      operationId: directCreateParcel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelForDirectCreation'
        description: Representation that describes the parcel you want to create
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: Parcel was successfully created
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create parcel
      tags:
        - Shipments (Operations)
  /api/shipments/search:
    post:
      deprecated: false
      description: Search for Shipment
      operationId: searchShipment
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShipmentPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List shipments (search)
      x-fft-permissions:
        - SHIPMENT_READ
      tags:
        - Shipments (Operations)
  /api/shippinginformation:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves shippingInformation entities based on provided search
        criteria.
      operationId: getShippingInformation
      parameters:
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
            type: string
        - description: number of entities to show. Max value is 500
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 500
            minimum: 1
            type: integer
        - description: filter by facilityRefs
          in: query
          name: facilityRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - description: filter by tenantOrderId
          in: query
          name: tenantOrderId
          required: false
          schema:
            example: ORDER-12345
            type: string
        - description: >-
            the value by which results should be ordered by. If nothing is
            passed return values are sorted by id
          in: query
          name: orderBy
          required: false
          schema:
            example: CREATED_ASC
            type: string
        - description: >-
            if set to true, the total count of entities found by the given
            search criteria will be returned. Default is false
          in: query
          name: withTotal
          required: false
          schema:
            example: true
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingInformationResponse'
          description: Successfully retrieved shippingInformation.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get shippingInformation
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - ShippingInformation (carrier)
      x-badges:
        - color: red
          label: ALPHA
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates a new shippingInformation.
      operationId: createShippingInformation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingInformationForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingInformation'
          description: Successfully created the shippingInformation.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create a shippingInformation
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - ShippingInformation (carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/shippinginformation/{shippingInformationId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves a single shippingInformation using its unique identifier.
      operationId: getShippingInformationById
      parameters:
        - in: path
          name: shippingInformationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingInformation'
          description: Successfully retrieved the shippingInformation.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get a shippingInformation by its ID
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - ShippingInformation (carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/shippinginformation/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for ShippingInformation
      operationId: searchShippingInformation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingInformationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingInformationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List ShippingInformation (search)
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - ShippingInformation (carrier)
      x-badges:
        - color: orange
          label: BETA
  /api/simulations/orders:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        all simulation orders
      operationId: listSimulationOrders
      parameters:
        - in: query
          name: size
          required: false
          schema:
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationOrder'
          description: Simulation orders were found & you were allowed to access them.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List simulation orders
      x-fft-permissions:
        - SIMULATION_ORDER_READ
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create a simulation order for testing purposes
      operationId: createSimulationOrder
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulationOrderForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationOrder'
          description: The simulation order has been successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create simulation order
      x-fft-permissions:
        - SIMULATION_ORDER_WRITE
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/simulations/orders/{id}:
    delete:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Delete a simulation order
      operationId: deleteSimulationOrder
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: The simulation order was successfully deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete simulation order
      x-fft-permissions:
        - SIMULATION_ORDER_WRITE
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        a single simulation order by id
      operationId: getSimulationOrder
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationOrder'
          description: The simulation order was found
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get simulation order
      x-fft-permissions:
        - SIMULATION_ORDER_READ
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    patch:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Partially update a simulation order
      operationId: patchSimulationOrder
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulationOrderForPartialUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationOrder'
          description: The simulation order was successfully patched
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Patch simulation order
      x-fft-permissions:
        - SIMULATION_ORDER_WRITE
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
    put:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update a simulation order
      operationId: updateSimulationOrder
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulationOrderForUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationOrder'
          description: The simulation order was successfully updated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Update simulation order
      x-fft-permissions:
        - SIMULATION_ORDER_WRITE
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/simulations/orders/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for SimulationOrder
      operationId: searchSimulationOrder
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulationOrderSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimulationOrderPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Search simulation orders
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - Simulation Orders (DOMS)
      x-badges:
        - color: red
          label: ALPHA
  /api/stacks:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        all Stacks respecting the given filter
      operationId: getStacks
      parameters:
        - description: entity to start after
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            type: integer
        - description: facilities to filter the results
          explode: true
          in: query
          name: facilityRefs
          required: false
          schema:
            example:
              - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
              - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StackResponse'
          description: >-
            Entities were found & you were allowed to access it. The result is
            in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get all Stacks respecting the given filter
      x-fft-permissions:
        - STACKS_READ
      tags:
        - Stacks (Operations)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Create stack
      operationId: createStack
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StackForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stack'
          description: Stack created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create stack
      x-fft-permissions:
        - STACKS_WRITE
      tags:
        - Stacks (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/stacks/{stackId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />Get
        Stack respecting the given id
      operationId: getStackById
      parameters:
        - in: path
          name: stackId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stack'
          description: >-
            Entity was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get stack
      x-fft-permissions:
        - STACKS_READ
      tags:
        - Stacks (Operations)
      x-badges:
        - color: orange
          label: BETA
  /api/status:
    get:
      description: Returns the platform status.
      operationId: status
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: The status result
      summary: Get status
      tags:
        - Health (Infrastructure)
  /api/stocks:
    get:
      deprecated: false
      description: ''
      operationId: getStocks
      parameters:
        - in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - in: query
          name: tenantFacilityId
          required: false
          schema:
            type: string
        - in: query
          name: tenantArticleId
          required: false
          schema:
            example: MY_ARTICLE_ID
            items:
              type: string
            maxItems: 500
            type: array
        - in: query
          name: locationRef
          required: false
          schema:
            example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            items:
              type: string
            maxItems: 500
            type: array
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockPaginatedResult'
          description: Stocks
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List stocks
      x-fft-permissions:
        - STOCK_READ
      tags:
        - Stocks (Inventory)
    post:
      deprecated: false
      description: ''
      operationId: createStock
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stock'
          description: Stock was created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create stock
      x-fft-permissions:
        - STOCK_WRITE
      tags:
        - Stocks (Inventory)
    put:
      deprecated: false
      description: Update and create many stocks at once
      operationId: upsertStocks
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StocksForUpsert'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StockUpsertOperationResult'
                type: array
          description: Stock upsert result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update stocks
      x-fft-permissions:
        - STOCK_WRITE
      tags:
        - Stocks (Inventory)
  /api/stocks/{stockId}:
    delete:
      deprecated: false
      description: ''
      operationId: deleteStock
      parameters:
        - in: path
          name: stockId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Stock was deleted.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Delete stock
      x-fft-permissions:
        - STOCK_WRITE
      tags:
        - Stocks (Inventory)
    get:
      deprecated: false
      description: ''
      operationId: getStock
      parameters:
        - in: path
          name: stockId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stock'
          description: Stock
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get stock
      x-fft-permissions:
        - STOCK_READ
      tags:
        - Stocks (Inventory)
    put:
      deprecated: false
      description: ''
      operationId: updateStock
      parameters:
        - in: path
          name: stockId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/StockForUpdate'
                - not:
                    required:
                      - version
                  properties:
                    locationRef:
                      nullable: true
                      type: string
                    value:
                      format: int32
                      minimum: 0
                      type: integer
                  required:
                    - value
                  type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stock'
          description: Stock
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Update stock
      x-fft-permissions:
        - STOCK_WRITE
      tags:
        - Stocks (Inventory)
  /api/stocks/actions:
    post:
      deprecated: false
      description: ''
      operationId: performStocksActions
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockActionResult'
          description: Stock action result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Call stock action
      x-fft-permissions:
        - STOCK_WRITE
      tags:
        - Stocks (Inventory)
  /api/stocks/search:
    post:
      deprecated: false
      description: Search for Stock
      operationId: searchStock
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List stocks (search)
      x-fft-permissions:
        - STOCK_READ
      tags:
        - Stocks (Inventory)
  /api/stocks/summaries:
    get:
      deprecated: false
      description: Get the accumulated Stock for each Article
      operationId: getStockSummaries
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - description: >-
            The stockSummaries.article.tenantArticleId value should be used for
            pagination.
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - explode: true
          in: query
          name: facilityGroupRefs
          required: false
          schema:
            example:
              - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
              - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
            items:
              type: string
            maxItems: 1
            type: array
        - explode: false
          in: query
          name: facilityServiceTypes
          required: false
          schema:
            items:
              enum:
                - SHIP_FROM_STORE
                - PICKUP
              type: string
            type: array
        - explode: false
          in: query
          name: facilityStatus
          required: false
          schema:
            items:
              enum:
                - ONLINE
                - SUSPENDED
                - OFFLINE
              type: string
            type: array
        - explode: true
          in: query
          name: facilityRefs
          required: false
          schema:
            items:
              type: string
            type: array
        - in: query
          name: allowStale
          required: false
          schema:
            type: boolean
        - explode: true
          in: query
          name: tenantArticleIds
          required: false
          schema:
            items:
              type: string
            type: array
        - description: >-
            Returns stock summaries using adaptive batching to reduce latency
            spikes, as a consequence response time will have a more consistent
            upper bound but page size may be reduced below the maximum - This
            overrides `size` argument.
          in: query
          name: maxPageSize
          required: false
          schema:
            maximum: 100
            minimum: 1
            type: number
        - description: >-
            The channels to included under "channelAdjusted" in the stock
            summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
            unallocated stock."
          explode: true
          in: query
          name: channelRefs
          required: false
          schema:
            example:
              - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
              - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
            items:
              type: string
            maxItems: 50
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockSummaries'
          description: >-
            Stock summaries was loaded & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List stock summaries
      x-fft-permissions:
        - STOCK_AVAILABILITIES_READ
      tags:
        - Stocks (Inventory)
  /api/storagelocations/search:
    post:
      deprecated: false
      description: Search for StorageLocation
      operationId: searchStorageLocation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageLocationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List storage locations (search)
      x-fft-permissions:
        - STORAGE_LOCATION_READ
      tags:
        - Storage Locations (Inventory)
  /api/stowjobs:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getStowJobs
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - in: query
          name: sort
          required: false
          schema:
            enum:
              - LAST_MODIFIED_ASC
              - LAST_MODIFIED_DESC
            type: string
        - in: query
          name: facilityRef
          required: false
          schema:
            items:
              type: string
            type: array
        - in: query
          name: tenantArticleId
          required: false
          schema:
            items:
              type: string
            type: array
        - in: query
          name: locationRef
          required: false
          schema:
            items:
              type: string
            type: array
        - explode: false
          in: query
          name: status
          required: false
          schema:
            items:
              enum:
                - OPEN
                - IN_PROGRESS
                - CLOSED
                - CANCELED
                - PAUSED
              type: string
            type: array
        - in: query
          name: stockRef
          required: false
          schema:
            items:
              type: string
            type: array
        - in: query
          name: shortId
          required: false
          schema:
            items:
              type: string
            type: array
        - in: query
          name: priority
          required: false
          schema:
            items:
              type: number
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StowJobPaginatedResult'
          description: Paginated result containing the matching Stow Job entities
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List stow jobs
      x-fft-permissions:
        - STOW_JOB_READ
      tags:
        - Stowing (Inventory)
      x-badges:
        - color: orange
          label: BETA
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: createStowJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StowJobForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StowJob'
          description: Created Stow Job entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            The syntax of the request content was correct, but it was unable to
            process the contained instructions, possibly due to semantic errors.
      summary: Create stow job
      x-fft-permissions:
        - STOW_JOB_FULL_WRITE
      tags:
        - Stowing (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/stowjobs/{stowJobId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: getStowJob
      parameters:
        - in: path
          name: stowJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StowJob'
          description: Requested Stow Job entity
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get stow job
      x-fft-permissions:
        - STOW_JOB_READ
      tags:
        - Stowing (Inventory)
      x-badges:
        - color: orange
          label: BETA
    patch:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: Patch StowJob
      parameters:
        - in: path
          name: stowJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StowJobForPatch'
        required: true
      responses:
        '200':
          description: Stow Job successfully patched
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            The syntax of the request content was correct, but it was unable to
            process the contained instructions, possibly due to semantic errors.
      summary: Update stow job
      x-fft-permissions:
        - STOW_JOB_FULL_WRITE
      tags:
        - Stowing (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/stowjobs/{stowJobId}/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: Post StowJob Actions
      parameters:
        - in: path
          name: stowJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/StartStowJobAction'
                - $ref: '#/components/schemas/PauseStowJobAction'
                - $ref: '#/components/schemas/CancelStowJobAction'
                - $ref: '#/components/schemas/ReopenStowJobAction'
                - $ref: '#/components/schemas/CloseStowJobAction'
                - $ref: '#/components/schemas/ModifyStowLineItemsAction'
                - $ref: '#/components/schemas/StowJobReplaceAssignedUsersAction'
        required: true
      responses:
        '200':
          description: Actions successfully performed
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            The syntax of the request content was correct, but it was unable to
            process the contained instructions, possibly due to semantic errors.
      summary: Call stow job action
      tags:
        - Stowing (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/stowjobs/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for StowJob
      operationId: searchStowJob
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StowJobSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StowJobPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List stow jobs (search)
      x-fft-permissions:
        - STOW_JOB_READ
      tags:
        - Stowing (Inventory)
      x-badges:
        - color: orange
          label: BETA
  /api/subscriptions:
    get:
      description: ''
      operationId: getSubscriptions
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscriptions'
          description: All subscriptions.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List subscriptions
      tags:
        - Eventing (Core)
    post:
      description: >-
        Add new Subscription. Please note: Currently it is only possible to add
        max. five subscriptions per event.
      operationId: addSubscription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionForCreation'
        description: Representation that describes the subscription
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: Subscription is successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create subscription
      tags:
        - Eventing (Core)
  /api/subscriptions/{subscriptionId}:
    delete:
      description: ''
      operationId: deleteSubscription
      parameters:
        - description: ID of the subscription you want to delete
          in: path
          name: subscriptionId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: Subscription is successfully deleted.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Delete subscription
      tags:
        - Eventing (Core)
  /api/substitutes:
    get:
      operationId: getResultingSubstitutesForTenantArticleId
      parameters:
        - description: the tenantArticleId substitutes are requested for
          in: query
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Substitutes'
          description: >-
            There are substitutes for the given tenantArticleId. The result can
            be found in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: List substitutes
      tags:
        - Picking (Operations)
  /api/substitutes/{tenantArticleId}:
    delete:
      description: ''
      operationId: deleteSubstitutesForTenantArticleId
      parameters:
        - description: the tenant article ID the subsitutes should be deleted for
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            The substitutes for the given tenantArticleId were successfully
            deleted
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Delete substitutes
      tags:
        - Picking (Operations)
    get:
      description: Get the substitutes for a given tenant article id
      operationId: getSubstitutesForTenantArticleId
      parameters:
        - description: ''
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Substitutes'
          description: >-
            The substitutes for the given tenantArticleId can be found in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility not found
      summary: Get substitutes
      tags:
        - Picking (Operations)
    put:
      description: ''
      operationId: putSubstitutesForTenantArticleID
      parameters:
        - description: Tenant article ID of the article the substitutes should be set for
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubstitutesForUpsert'
        description: substitutes to set
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Substitutes'
          description: The substitutes for tenantArticleId were successfully updated
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      summary: Set substitutes
      tags:
        - Picking (Operations)
  /api/supportedevents:
    get:
      description: ''
      operationId: getEvents
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedEvents'
          description: All supported events.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List supported events
      tags:
        - Eventing (Core)
  /api/tags:
    get:
      description: ''
      operationId: getTags
      parameters:
        - description: all entities
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedTags'
          description: The current list of available tags
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: No more elements available
      summary: List tags
      tags:
        - Tags (Core)
    post:
      description: ''
      operationId: addTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagForCreation'
        description: Tag object
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: The tag was successfully created.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Create tag
      tags:
        - Tags (Core)
  /api/tags/{tagRef}:
    get:
      description: ''
      operationId: getTag
      parameters:
        - description: Id of the tag you want to get
          in: path
          name: tagRef
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: >-
            Tag was found & you were allowed to access it. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: User not found
      summary: Get tag
      tags:
        - Tags (Core)
    patch:
      description: ''
      operationId: putTag
      parameters:
        - description: Id of the tag you want to update
          in: path
          name: tagRef
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagPatchActions'
        description: Tag patch action
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: >-
            Tag was found & you were allowed to access it. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Tag not found
      summary: Update tag
      tags:
        - Tags (Core)
  /api/tags/packing/needspacking:
    post:
      description: ''
      operationId: getNeedsPacking
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/TagReference'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NeedsPacking'
          description: >-
            NeedsPacking information for this tag was found & you were allowed
            to access it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Entity not found
      summary: Get needs packing for tags
      tags:
        - Packing Configuration (Operations)
  /api/tags/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Tag
      operationId: searchTag
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List tags (search)
      x-fft-permissions:
        - TAG_READ
      tags:
        - Tags
      x-badges:
        - color: orange
          label: BETA
  /api/trackinginformation:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves all found tracking information using the passed search
        parameters.
      operationId: trackingInformationList
      parameters:
        - description: Ordering of the found tracking information.
          in: query
          name: orderBy
          required: false
          schema:
            enum:
              - CREATED_ASC
              - CREATED_DESC
              - LAST_MODIFIED_ASC
              - LAST_MODIFIED_DESC
            example: CREATED_ASC
            type: string
        - description: Amount of results of this call.
          in: query
          name: size
          required: false
          schema:
            example: 5
            type: integer
        - description: Used for pagination, return sorted results after this id.
          in: query
          name: startAfterId
          required: false
          schema:
            example: 2d19415f-a8e6-4480-aa7d-e72ad85716a2
            type: string
        - description: >-
            Flag to specify if the result should include a sum of all possible
            found values for this filter.
          in: query
          name: withTotal
          required: false
          schema:
            default: false
            example: true
            type: boolean
        - description: Possible facility refs to filter by
          in: query
          name: facilityRefs
          required: false
          schema:
            example: c8fe61e3-ba3f-461e-bc14-8fc610ce4cc2
            items:
              type: string
            maxItems: 20
            minItems: 0
            type: array
        - description: Connected shipping information ref to filter by
          in: query
          name: shippingInformationRef
          required: false
          schema:
            example: 3d844fea-c9d0-4386-841c-d688cb205df3
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingInformationListResponse'
          description: >-
            Successfully retrieved all trackingInformation matching the given
            parameters.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: Get all tracking information by parameters
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - TrackingInformation (Carrier)
      x-badges:
        - color: red
          label: ALPHA
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Creates a new tracking information.
      operationId: createTrackingInformation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackingInformationForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingInformation'
          description: Successfully created the trackingInformation.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create a tracking information
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - TrackingInformation (Carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/trackinginformation/{trackingInformationId}:
    get:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Retrieves a single tracking information using its unique identifier.
      operationId: getTrackingInformationById
      parameters:
        - in: path
          name: trackingInformationId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingInformation'
          description: Successfully retrieved the trackingInformation.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get a tracking information by its ID
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - TrackingInformation (Carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/trackinginformation/{trackingInformationId}/actions:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Handle Action on an existing tracking information.
      operationId: trackingInformationActions
      parameters:
        - in: path
          name: trackingInformationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: >-
                    #/components/schemas/TrackingInformationAddTrackingEventActionParameter
                - $ref: >-
                    #/components/schemas/TrackingInformationRemoveTrackingEventsParameter
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingInformation'
          description: Successfully handled the action on the tracking information.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: handle tracking information action
      x-fft-permissions:
        - ADMIN_MODULES_WRITE
      tags:
        - TrackingInformation (Carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/trackinginformation/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for TrackingInformation
      operationId: searchTrackingInformation
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TrackingInformationSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingInformationPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List tracking information (search)
      x-fft-permissions:
        - ADMIN_MODULES_READ
      tags:
        - TrackingInformation (Carrier)
      x-badges:
        - color: red
          label: ALPHA
  /api/users:
    get:
      deprecated: false
      description: ''
      operationId: getAllUsers
      parameters:
        - in: query
          name: size
          required: false
          schema:
            default: 25
            example: 25
            maximum: 100
            minimum: 1
            type: number
        - in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: Order the users by this field
          in: query
          name: orderBy
          required: false
          schema:
            type: string
        - description: Filter the users by this facility
          in: query
          name: facilityId
          required: false
          schema:
            type: string
        - description: >-
            Include all admins in the result (only applicable if facilityId is
            set)
          in: query
          name: includeAdminUsers
          required: false
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: The users were successfully returned.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: List users
      x-fft-permissions:
        - USERS_READ
      tags:
        - User Management (Core)
    post:
      deprecated: false
      description: ''
      operationId: createUser
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: The users was successfully created.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Creates user
      x-fft-permissions:
        - USER_READ
        - USER_WRITE
      tags:
        - User Management (Core)
  /api/users/{userId}:
    delete:
      deprecated: false
      description: ''
      operationId: deleteUser
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The deleted user.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Delete user
      x-fft-permissions:
        - USER_READ
        - USER_WRITE
      tags:
        - User Management (Core)
    get:
      deprecated: false
      description: ''
      operationId: getUser
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: The user.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Return user
      x-fft-permissions:
        - USER_READ
      tags:
        - User Management (Core)
    patch:
      deprecated: false
      description: ''
      operationId: changeUser
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPatchActions'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: The modified user.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Update user
      x-fft-permissions:
        - USER_MODIFY
      tags:
        - User Management (Core)
  /api/users/{userId}/assignedFacilities:
    post:
      deprecated: false
      description: ''
      operationId: assignFacility
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAssignedFacilityForCreation'
        required: true
      responses:
        '200':
          description: The facilities were successfully assigned to the user.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Create facility assignment
      x-fft-permissions:
        - USER_READ
        - USER_WRITE
      tags:
        - User Management (Core)
  /api/users/{userId}/permissions:
    get:
      deprecated: false
      description: Returns the roles of a user.
      operationId: getUserRoles
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The roles of the user.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested entity was not found
      summary: Get user roles
      x-fft-permissions:
        - USER_READ
      tags:
        - User Management (Core)
  /api/users/me:
    patch:
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Update my own data.
      operationId: updateMe
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyUserPersonalData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: Updating my data was successful.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
      summary: Update me user
      x-fft-permissions:
        - CURRENT_USER_MODIFY
      tags:
        - User Management (Core)
  /api/users/me/actions:
    post:
      deprecated: false
      description: Executes an action to manipulate my user.
      operationId: executeMeAction
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/ModifyMeAction'
                - $ref: '#/components/schemas/ModifyMyCredentialsAction'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: User action was successfully executed.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A version conflict occurred.
      summary: Call user action
      x-fft-permissions:
        - CURRENT_USER_MODIFY
      tags:
        - User Management (Core)
  /api/users/me/effectivepermissions:
    get:
      deprecated: false
      description: Returns the effective permissions of the user.
      operationId: getEffectivePermissions
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EffectivePermissionsResponse'
          description: The effective permissions of the user.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
      summary: Return effective permissions
      x-fft-permissions:
        - CURRENT_USER_READ
      tags:
        - User Management (Core)
  /api/users/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for User
      operationId: searchUser
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List users (search)
      x-fft-permissions:
        - USERS_READ
      tags:
        - User Management (Core)
      x-badges:
        - color: orange
          label: BETA
  /api/validations/postalcodes:
    post:
      description: ''
      operationId: validatePostalCode
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostalCodeValidation'
        description: Branding object
        required: true
      responses:
        '200':
          description: The given postal code is valid for the given country
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The given postal code is invalid for the given country
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The given country can't be validated
      summary: Validate postal code
      tags:
        - Validations (Core)
  /api/workflows/search:
    post:
      deprecated: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Search for Workflow
      operationId: searchWorkflow
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowPaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List workflows (search)
      x-fft-permissions:
        - WORKFLOW_DEFINITION_READ
      tags:
        - Workflow Management (Core)
      x-badges:
        - color: red
          label: ALPHA
  /api/zones/search:
    post:
      deprecated: false
      description: Search for Zone
      operationId: searchZone
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoneSearchPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZonePaginatedResult'
          description: Your search result
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      summary: List zones (search)
      x-fft-permissions:
        - ZONE_READ
      tags:
        - Storage Locations (Inventory)
  /graphql:
    get:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Returns the GraphQL playground.
      operationId: getGraphQLPlayground
      responses:
        '200':
          description: The GraphQL playground
      summary: Get GraphQL
      tags:
        - GraphQL (Infrastructure)
      x-badges:
        - color: red
          label: ALPHA
    post:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      operationId: executeGraphQLCommand
      responses:
        '200':
          description: The GraphQL command was successfully executed.
        '400':
          description: GraphQL validation error
      summary: Execute GraphQL command
      tags:
        - GraphQL (Infrastructure)
      x-badges:
        - color: red
          label: ALPHA
components:
  schemas:
    AbortPickJob:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: Use value 'AbortPickJob', because you want to cancel a pickjob
              enum:
                - AbortPickJob
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/pickjobs/:id/actions instead
      title: AbortPickJob
      xml:
        name: AbortPickJob
    AbstractArticle:
      properties:
        titleLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations for the title of the product
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Ensure that no
            authentication is needed to fetch the image.
          example: https://example.com/resource
          type: string
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          description: Weight value is in gram
          minimum: 0
          type: number
      required:
        - tenantArticleId
        - title
      title: AbstractArticle
      type: object
      description: AbstractArticle
    AbstractArticleForCreation:
      properties:
        titleLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations for the title of the product
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Ensure that no
            authentication is needed to fetch the image.
          example: https://example.com/resource
          type: string
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          description: Weight value is in gram
          minimum: 0
          type: number
      required:
        - title
      title: AbstractArticleForCreation
      type: object
      description: AbstractArticleForCreation
    AbstractCarrierCredentials:
      properties:
        key:
          description: The key identifying the carrier credentials type
          type: string
      required:
        - key
      title: AbstractCarrierCredentials
      type: object
      description: AbstractCarrierCredentials
    AbstractFacilityActionsParameter:
      discriminator:
        propertyName: name
      properties:
        name:
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: AbstractFacilityActionsParameter
      description: AbstractFacilityActionsParameter
    AbstractModificationAction:
      discriminator:
        propertyName: action
      properties:
        action:
          description: ''
          enum:
            - AddAllowedValueToTag
            - ModifyFacility
            - ModifyListing
            - ModifyRetainedOfflineStock
            - ModifyListingReactivationAfter
            - ModifyUser
            - ModifyCarrier
            - ModifyShortpick
            - ModifyRoutingPlan
            - ModifyFence
            - ModifyRating
            - ModifyTimingMode
            - ModifyGlobalRoutingConfiguration
            - ModifyOrderSplit
            - ModifyPrioritization
            - ModifyFeature
            - ModifyParcel
            - ModifyParcelLoadUnit
            - ModifyPartialStock
            - AddTagsToProcess
            - AssignFacilityToProcess
            - UpdateGdprCleanupDateAction
            - ModifyStorageLocation
            - UnlockOrder
          example: <Use the corresponding action, see documentation>
          type: string
      required:
        - action
      type: object
      xml:
        name: AbstractModificationAction
      title: AbstractModificationAction
      description: AbstractModificationAction
    AbstractModifyCarrierCredentials:
      properties:
        key:
          description: The key identifying the carrier credentials type
          type: string
      required:
        - key
      title: AbstractModifyCarrierCredentials
      type: object
      description: AbstractModifyCarrierCredentials
    AbstractOrderActionsParameter:
      discriminator:
        propertyName: name
      properties:
        name:
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: AbstractOrderActionsParameter
      description: AbstractOrderActionsParameter
    AbstractOrderLineItemActionsParameter:
      discriminator:
        propertyName: name
      properties:
        name:
          type: string
        version:
          description: Version of the order to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: AbstractOrderLineItemActionsParameter
      description: AbstractOrderLineItemActionsParameter
    AbstractProcessActionsParameter:
      discriminator:
        propertyName: name
      properties:
        name:
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: AbstractProcessActionsParameter
      description: AbstractProcessActionsParameter
    AbstractRatingConfiguration:
      description: Base configuration for ratings. See documentation for details.
      properties:
        type:
          $ref: '#/components/schemas/RatingConfigurationType'
      title: AbstractRatingConfiguration
      type: object
      xml:
        name: AbstractRatingConfiguration
    AbstractReason:
      allOf:
        - $ref: '#/components/schemas/AbstractReasonForCreation'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        action:
          description: The action this reason can be attached to.
          type: string
        id:
          description: The id of the Reason
          type: string
      required:
        - id
        - action
      type: object
      xml:
        name: AbstractReason
      title: AbstractReason
      description: AbstractReason
    AbstractReasonForCreation:
      additionalProperties: false
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        reason:
          description: Text explaining the reason for a supported action.
          example: Rerouted because of an issue in the Facility.
          type: string
      required:
        - reason
        - reasonLocalized
      type: object
      xml:
        name: AbstractReasonForCreation
      title: AbstractReasonForCreation
      description: AbstractReasonForCreation
    AbstractReasonForModification:
      additionalProperties: false
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        reason:
          description: Text explaining the reason for a supported action.
          example: Rerouted because of an issue in the Facility.
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - reason
        - reasonLocalized
      type: object
      xml:
        name: AbstractReasonForModification
      title: AbstractReasonForModification
      description: AbstractReasonForModification
    AbstractReasons:
      properties:
        hasNextPage:
          description: True if there are more results after the current page
          type: boolean
        reasons:
          items:
            $ref: '#/components/schemas/AbstractReason'
          type: array
        total:
          description: Total number of found entities for this query
          type: integer
      required:
        - reasons
        - hasNextPage
        - total
      type: object
      xml:
        name: AbstractReasons
      title: AbstractReasons
      description: AbstractReasons
    AbstractRoutingStrategyActionsParameter:
      discriminator:
        propertyName: name
      properties:
        name:
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: AbstractRoutingStrategyActionsParameter
      description: AbstractRoutingStrategyActionsParameter
    ActivationTimeFrame:
      additionalProperties: false
      properties:
        activeFrom:
          description: >-
            Sets a date before which the associated entity does not become
            active
          format: date-time
          type: string
        activeUntil:
          description: Sets a date after which the associated entity becomes active
          format: date-time
          type: string
        recurrence:
          $ref: '#/components/schemas/ActivationTimeFrameRecurrenceType'
      required:
        - recurrence
      type: object
      title: ActivationTimeFrame
      description: ActivationTimeFrame
    ActivationTimeFrameRecurrenceType:
      enum:
        - YEARLY
        - NONRECURRING
      type: string
      title: ActivationTimeFrameRecurrenceType
      description: ActivationTimeFrameRecurrenceType
    AddAllowedValueToTag:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'AddAllowedValueToTag', because you want to add an
                allowed value to a tag
              enum:
                - AddAllowedValueToTag
              type: string
            allowedValue:
              type: string
          required:
            - action
            - allowedValue
          type: object
      description: Action to add allowed values to a tag
      title: AddAllowedValueToTag
      xml:
        name: AddAllowedValueToTag
    AddChannelAction:
      properties:
        channel:
          oneOf:
            - $ref: '#/components/schemas/EmailNotificationChannelForCreation'
            - $ref: '#/components/schemas/ClientNotificationChannelForCreation'
        name:
          enum:
            - ADD_CHANNEL
          type: string
        version:
          type: number
      required:
        - name
        - channel
        - version
      title: AddChannelAction
      type: object
      description: AddChannelAction
    AddCustomsDocumentToParcelContent:
      additionalProperties: false
      description: File and Document for this Label
      properties:
        labelFile:
          $ref: '#/components/schemas/AddLabelsToParcelFile'
      required:
        - labelFile
      type: object
      title: AddCustomsDocumentToParcelContent
    AddFacilitiesToGroupActionParameter:
      properties:
        facilitiesToAdd:
          description: >-
            Array of facility references to add to the group. Each facility can
            be assigned to at most 20 facility groups (default).
          items:
            type: string
          maxItems: 200
          minItems: 1
          type: array
        name:
          description: The name of the action
          enum:
            - ADD_FACILITIES_TO_GROUP
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: number
      required:
        - name
        - facilitiesToAdd
      title: AddFacilitiesToGroupActionParameter
      type: object
      description: AddFacilitiesToGroupActionParameter
    AddFacilitiesToGroupVersionlessActionParameter:
      properties:
        facilitiesToAdd:
          description: >-
            Array of facility references to add to the group. Each facility can
            be assigned to at most 20 facility groups (default).
          items:
            type: string
          maxItems: 200
          minItems: 1
          type: array
        name:
          description: The name of the action
          enum:
            - VERSIONLESS_ADD_FACILITIES_TO_GROUP
          type: string
      required:
        - name
        - facilitiesToAdd
      title: AddFacilitiesToGroupVersionlessActionParameter
      type: object
      description: AddFacilitiesToGroupVersionlessActionParameter
    AddItemReturnToItemReturnJob:
      properties:
        itemReturnForCreation:
          $ref: '#/components/schemas/ItemReturnForCreation'
        itemReturnJobVersion:
          description: Version of the itemReturnJob the itemReturn gets added to
          example: 1
          minimum: 0
          type: integer
      required:
        - itemReturnForCreation
        - itemReturnJobVersion
      title: AddItemReturnToItemReturnJob
      type: object
      description: AddItemReturnToItemReturnJob
    AdditionalInformation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        description:
          description: >-
            Translated description derived from descriptionLocalized based on
            the requested locale
          example: Please describe the damage in detail
          minLength: 1
          type: string
        id:
          description: Unique ID of this additional information entry
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        isMandatory:
          description: Indicates if filling in this additional information is mandatory
          example: false
          type: boolean
        name:
          description: >-
            Translated name derived from nameLocalized based on the requested
            locale
          example: Damage Description
          minLength: 1
          type: string
        tenantAdditionalInformationId:
          description: >-
            Id to identifiy the additional information on an external system.
            Must be unique per CustomService.
          example: AddInfoABC123
          minLength: 1
          type: string
        valueType:
          description: Type of the value
          enum:
            - STRING
            - BOOLEAN
            - NUMBER
            - NOVALUE
            - INPUT_MULTILINE_STRING
          example: NUMBER
          type: string
      required:
        - nameLocalized
        - valueType
        - id
      title: AdditionalInformation
      type: object
      description: AdditionalInformation
    AdditionalInformationForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        isMandatory:
          description: Indicates if filling in this additional information is mandatory
          example: false
          type: boolean
        tenantAdditionalInformationId:
          description: >-
            Id to identifiy the additional information on an external system.
            Must be unique per CustomService.
          example: AddInfoABC123
          minLength: 1
          type: string
        valueType:
          description: Type of the value
          enum:
            - STRING
            - BOOLEAN
            - NUMBER
            - NOVALUE
            - INPUT_MULTILINE_STRING
          example: NUMBER
          type: string
      required:
        - nameLocalized
        - valueType
      title: AdditionalInformationForCreation
      type: object
      description: AdditionalInformationForCreation
    AdditionalShippingArticleAttribute:
      properties:
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized description of this shipping article attribute
        category:
          description: The category of this shipping article attribute
          enum:
            - customs
            - dimensions
            - insurance
          type: string
        dataType:
          description: The data type of this shipping article attribute
          enum:
            - NUMBER
            - STRING
          type: string
        description:
          description: Description of this shipping article attribute
          type: string
        referencedField:
          description: The referenced field for this shipping article attribute
          enum:
            - attributes.weightPerUnit
            - attributes.hsCode
            - attributes.currency
            - attributes.valuePerUnit
            - attributes.countryOfManufacture
          type: string
      required:
        - referencedField
        - dataType
        - category
        - descriptionLocalized
      title: AdditionalShippingArticleAttribute
      type: object
      description: AdditionalShippingArticleAttribute
    AdditionalShippingAttribute:
      properties:
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized description of this shipping attribute
        dataType:
          description: The data type of this shipping attribute
          enum:
            - Number
            - String
            - Date
            - Boolean
          type: string
        description:
          description: Description of this shipping attribute
          type: string
        referencedField:
          description: >-
            - dimensions.weight: will be calculated from
            MandatoryShippingArticleAttribute.attributes.weightPerUnit if items
            with weightPerUnit is set on all items

            - productValue: will be calculated from
            MandatoryShippingArticleAttribute.attributes.pricePerUnit if items
            with pricePerUnit is set on all items
          enum:
            - dimensions.weight
            - productValue
            - pickUpInformation.startTime
            - pickUpInformation.endTime
            - services.BulkyGoods
            - services.Signature
            - services.AdultSignature
            - services.CustomerSignature
            - services.SaturdayDelivery
            - services.IdentityCheckPrivate
            - services.IdentityCheckCompany
            - services.AdditionalTransportInsurance
            - carrierInformation.shippingContainerNumber
            - services.NoNeighborDelivery
            - services.HandoverToRecipientOnly
            - services.IdentityAgeCheck18
          type: string
      title: AdditionalShippingAttribute
      type: object
      description: AdditionalShippingAttribute
    AddLabelsToParcelActionEnum:
      enum:
        - ADD_LABELS_TO_PARCEL
      type: string
      title: AddLabelsToParcelActionEnum
      description: AddLabelsToParcelActionEnum
    AddLabelsToParcelActionParameter:
      additionalProperties: false
      properties:
        closeParcel:
          default: false
          description: >-
            Close the parcel after adding this labels. Further adding will not
            be possible.
          example: true
          type: boolean
        customsDocument:
          $ref: '#/components/schemas/AddCustomsDocumentToParcelContent'
        labels:
          items:
            anyOf:
              - $ref: '#/components/schemas/AddLabelsToParcelContent'
              - $ref: '#/components/schemas/AddLabelsToParcelError'
          maxItems: 2
          minItems: 0
          type: array
        name:
          $ref: '#/components/schemas/AddLabelsToParcelActionEnum'
        tenantParcelId:
          description: Optional parameter to set or change the tenant parcel id
          example: MY-PARCEL-12345
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - labels
      title: AddLabelsToParcelActionParameter
      type: object
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />AddLabelsToParcelActionParameter
      x-badges:
        - color: orange
          label: BETA
    AddLabelsToParcelContent:
      additionalProperties: false
      description: File and Document for this Label
      properties:
        labelFile:
          $ref: '#/components/schemas/AddLabelsToParcelFile'
        labelType:
          $ref: '#/components/schemas/ParcelLabelType'
        trackingNumber:
          description: The reference number by the carrier
          example: '84168117830018'
          type: string
        trackingUrl:
          description: The URL to track this parcel
          example: http://track.io/3a186c51d4
          type: string
      required:
        - labelType
        - labelFile
        - trackingNumber
        - trackingUrl
      type: object
      title: AddLabelsToParcelContent
    AddLabelsToParcelError:
      additionalProperties: false
      description: Error values for a not successfull label request
      properties:
        errorCode:
          description: optional error code from the carrier
          example: ERROR_12345
          type: string
        errorDescription:
          description: raw text error message
          example: Postal code not found
          type: string
        labelType:
          $ref: '#/components/schemas/ParcelLabelType'
      required:
        - labelType
        - errorDescription
      type: object
      title: AddLabelsToParcelError
    AddLabelsToParcelFile:
      additionalProperties: false
      description: file for a given result
      properties:
        content:
          description: File content base64 encoded
          example: >-
            JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==
          type: string
        type:
          $ref: '#/components/schemas/DocumentType'
      required:
        - content
        - type
      type: object
      title: AddLabelsToParcelFile
    AddLineItemToPackingTargetContainer:
      additionalProperties: false
      description: Action to a line item to a packing target container.
      properties:
        action:
          description: >-
            'Deprecated. Use /api/packjobs/{packJobId}/actions with
            MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or
            MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'
          enum:
            - AddLineItemToPackingTargetContainer
          type: string
        lineItem:
          $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation'
      required:
        - action
        - lineItem
      title: AddLineItemToPackingTargetContainer
      type: object
      xml:
        name: AddLineItemToPackingTargetContainer
    AddRefuseReasonParameter:
      additionalProperties: false
      properties:
        availableRefuseReasonForCreation:
          $ref: '#/components/schemas/AvailableRefuseReasonForCreation'
        handoverConfigurationVersion:
          type: number
      required:
        - handoverConfigurationVersion
        - availableRefuseReasonForCreation
      type: object
      title: AddRefuseReasonParameter
      description: AddRefuseReasonParameter
    AddRemoteConfigurationScopeParameter:
      properties:
        remoteConfigVersion:
          description: The version of the remote config for optimistic locking
          example: 1
          minimum: 0
          type: number
        scope:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationScopeForCreation'
          description: The scope to add
      required:
        - scope
        - remoteConfigVersion
      title: AddRemoteConfigurationScopeParameter
      type: object
      description: AddRemoteConfigurationScopeParameter
    Address:
      properties:
        additionalAddressInfo:
          example: 'to care of: Mrs. Müller'
          type: string
        city:
          example: Langenfeld
          pattern: ^.+$
          type: string
        country:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the address. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        houseNumber:
          example: 42a
          pattern: ^.+$
          type: string
        phoneNumbers:
          items:
            properties:
              customAttributes:
                description: >-
                  Attributes that can be added to the phonenumber. These
                  attributes cannot be used within fulfillment processes, but it
                  could be useful to have the informations carried here.
                type: object
              label:
                description: >-
                  Can be used to give a description for the number, like
                  "private", "business number", etc.
                type: string
              type:
                enum:
                  - MOBILE
                  - PHONE
                type: string
              value:
                description: The number itself. We do not enforce any format (yet).
                type: string
            required:
              - value
              - type
            type: object
          maxItems: 500
          type: array
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        province:
          example: NRW
          pattern: ^.+$
          type: string
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      required:
        - street
        - city
        - postalCode
        - country
      type: object
      title: Address
      description: Address
    AddressType:
      description: >-
        Type of this address, used e.g. for communication with the carrier. Use
        POSTAL_ADDRESS for the address where the order should be shipped to,
        INVOICE_ADDRESS for the address where the invoice is sent to and
        PARCEL_LOCKER if a parcel locker is used for this order.
      enum:
        - POSTAL_ADDRESS
        - PARCEL_LOCKER
        - INVOICE_ADDRESS
      type: string
      title: AddressType
    AddServiceDataAvailableLineItemsActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS'
          enum:
            - ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS
          example: ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS
          type: string
        serviceDataAvailableLineItems:
          description: Service data available line items to be added
          items:
            $ref: '#/components/schemas/ServiceDataAvailableLineItemForCreation'
          maxItems: 50
          minItems: 1
          type: array
        serviceDataVersion:
          description: Version of the service data
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - serviceDataAvailableLineItems
        - serviceDataVersion
      title: AddServiceDataAvailableLineItemsActionParameter
      type: object
      description: AddServiceDataAvailableLineItemsActionParameter
    AddTagsToProcess:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'AddTagsToProcess', because you want to modify a
                process
              enum:
                - AddTagsToProcess
              type: string
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              maxItems: 500
              minItems: 1
              type: array
          required:
            - action
          type: object
      description: Action to add tags to a Process
      title: AddTagsToProcessAction
      xml:
        name: AddTagsToProcess
    AddTagsToProcessActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractProcessActionsParameter'
      description: Action to add tags to a process.
      properties:
        name:
          enum:
            - ADD_TAGS_TO_PROCESS
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 10
          minItems: 1
          type: array
      required:
        - name
        - version
        - tags
      title: AddTagsToProcessActionParameter
    AddTargetTimeToOperativeProcessEntitiesActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'ADD_TARGET_TIME_TO_OPERATIVE_PROCESS_ENTITIES'
          enum:
            - ADD_TARGET_TIME_TO_OPERATIVE_PROCESS_ENTITIES
          example: ADD_TARGET_TIME_TO_OPERATIVE_PROCESS_ENTITIES
          type: string
        operativeProcessVersion:
          description: Version of the service job
          example: 1
          minimum: 0
          type: integer
        targetTime:
          description: >-
            TargetTime you want to set for PickJobs, PackJobs, ServiceJobs and
            HandoverJobs that do not have a targetTime ServiceJob. Only effects
            entities of that operativeProcess.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
      required:
        - name
        - operativeProcessVersion
        - targetTime
      title: AddTargetTimeToOperativeProcessEntitiesActionParameter
      type: object
      description: AddTargetTimeToOperativeProcessEntitiesActionParameter
    AlternativeReturnAddressConfiguration:
      additionalProperties: false
      properties:
        alternativeReturnAddressPerTag:
          items:
            $ref: '#/components/schemas/AlternativeReturnAddressPerTag'
          minItems: 0
          type: array
      required:
        - alternativeReturnAddressPerTag
      title: AlternativeReturnAddressConfiguration
      description: AlternativeReturnAddressConfiguration
    AlternativeReturnAddressPerTag:
      additionalProperties: false
      properties:
        alternativeReturnAddress:
          $ref: '#/components/schemas/FacilityAddress'
        matchingValues:
          items:
            type: string
          minItems: 1
          type: array
        tagRef:
          description: needs to be an existing tag id
          type: string
      required:
        - tagRef
        - matchingValues
        - alternativeReturnAddress
      title: AlternativeReturnAddressPerTag
      description: AlternativeReturnAddressPerTag
    AnnounceItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - AnnounceItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: AnnounceItemReturnActionParameter
      type: object
      description: AnnounceItemReturnActionParameter
    ApiError:
      items:
        $ref: '#/components/schemas/ErrorInner'
      type: array
      xml:
        name: ApiError
      title: ApiError
      description: ApiError
    ArticleAttributeItem:
      properties:
        valueLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: >-
            The translations for the key of the attribute. This can be only
            filled with a descriptive category
        keyLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: >-
            The translations for the key of the attribute. This can be only
            filled with a descriptive category. Excluding for %%subtitle%%
        category:
          description: >-
            This category is used by fulfillmenttools to customize implemented
            processes.

            Categorized attributes are used by various processes and tools

            throughout fulfillmenttools. For a complete list of possible
            categories

            and their correct use, refer to the documentation.

            Default value: miscellaneous
          enum:
            - descriptive
            - miscellaneous
            - pickingSequence
            - customs
            - insurance
            - shop
            - dimensions
            - carrierService
            - salesPrice
            - basePrice
            - tax
            - discount
            - surcharge
            - subtotalBeforeDiscounts
            - subtotalAfterDiscounts
            - finalUnitPrice
            - finalLineItemPrice
          type: string
        context:
          allOf:
            - $ref: '#/components/schemas/ArticleAttributeItemContext'
          description: >-
            Context for salesPrice category and valuePerUnit key. Can only be
            set via Listing endpoints.
        key:
          description: |-
            Providing the key %%subtitle%% (see example) here will cause the
            value to appear, for example, in the App.
            With all other attributes also the key will be displayed in the
             clients.
          example: '%%subtitle%%'
          minLength: 1
          type: string
        priority:
          description: >-
            This value gives the priority in the respective attribute category.

            The lower the value the higher is the priority, for example,
            priority 1 is

            higher than priority 10. Attributes that have the highest priority

            might be selected for display in different articles of
            fulfillmenttools. Default

            value is 1001. For details please contact the product owners.
          example: 100
          format: int64
          maximum: 1001
          minimum: 1
          type: integer
        type:
          default: STRING
          description: The type of the attribute.
          enum:
            - STRING
            - NUMBER
            - CURRENCY
            - BOOLEAN
          example: STRING
          type: string
        value:
          example: 585er Gold
          minLength: 1
          type: string
      required:
        - key
        - value
      title: ArticleAttributeItem
      type: object
      description: ArticleAttributeItem
    ArticleAttributeItemContext:
      properties:
        type:
          description: Indicates the entity type the value refers to.
          enum:
            - FACILITY_GROUP
            - FACILITY
            - TAG_REFERENCE
          type: string
        value:
          description: Holds the reference to the entity the attribute refers to.
          minLength: 1
          type: string
      required:
        - type
        - value
      title: ArticleAttributeItemContext
      type: object
      description: ArticleAttributeItemContext
    ArticleAvailabilityStockValues:
      properties:
        availableForPicking:
          type: number
        availableOnStock:
          type: number
        stockOnHand:
          type: number
        total:
          type: number
      required:
        - total
        - stockOnHand
        - availableOnStock
        - availableForPicking
      title: ArticleAvailabilityStockValues
      type: object
      description: ArticleAvailabilityStockValues
    ArticleHistoryLog:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        measurementUnit:
          properties:
            abbreviationLocalized:
              $ref: '#/components/schemas/LocaleString'
          type: object
        newQuantity:
          type: number
        previousQuantity:
          type: number
        title:
          type: string
      required:
        - title
      type: object
      title: ArticleHistoryLog
      description: ArticleHistoryLog
    ArticleItem:
      additionalProperties: false
      properties:
        quantity:
          minimum: 1
          type: number
        tenantArticleRef:
          type: string
      required:
        - quantity
        - tenantArticleRef
      type: object
      title: ArticleItem
      description: ArticleItem
    ArticlePrice:
      additionalProperties: false
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          nullable: true
          type: string
        pricePerUnit:
          description: Price value for a given currency per unit
          example: 9.99
          minimum: 0
          type: number
      required:
        - pricePerUnit
        - currency
      type: object
      title: ArticlePrice
      description: ArticlePrice
    ArticleStockForecast:
      properties:
        created:
          format: date-time
          type: string
        cumulated:
          type: number
        cumulatedLowerBounds:
          items:
            type: number
          type: array
        cumulatedUpperBounds:
          items:
            type: number
          type: array
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        loadTime:
          format: date-time
          type: string
        lowerBounds:
          items:
            type: number
          type: array
        period:
          enum:
            - DAILY
          type: string
        point:
          type: number
        sourceDate:
          format: date-time
          type: string
        targetDate:
          format: date-time
          type: string
        tenantArticleId:
          type: string
        upperBounds:
          items:
            type: number
          type: array
      required:
        - id
        - tenantArticleId
        - created
        - lastModified
        - sourceDate
        - targetDate
        - loadTime
        - cumulated
        - cumulatedLowerBounds
        - cumulatedUpperBounds
        - lowerBounds
        - upperBounds
        - period
        - point
      title: ArticleStockForecast
      type: object
      description: ArticleStockForecast
    ArtifactMetadataItem:
      properties:
        buildDate:
          description: Date of the build of the artifact
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        download:
          properties:
            expiration:
              description: Expiration date of the download link
              example: 2020-02-03T08:45:50.525Z
              format: date-time
              type: string
            url:
              description: URL for the download of the artifact
              type: string
          type: object
        versionCode:
          description: Version Code of the artifact
          example: 42
          type: number
        versionName:
          description: Version Name of the artifact
          example: 1.0.42
          type: string
      required:
        - download
        - versionCode
        - versionName
        - buildDate
      type: object
      title: ArtifactMetadataItem
      description: ArtifactMetadataItem
    ArtifactMetadataItems:
      properties:
        artifacts:
          items:
            $ref: '#/components/schemas/ArtifactMetadataItem'
          type: array
        platform:
          description: Platform name for which the artifact list is generated
          example: android
          type: string
      required:
        - artifacts
        - platform
      type: object
      title: ArtifactMetadataItems
      description: ArtifactMetadataItems
    AssignedGroup:
      properties:
        facilityRefs:
          items:
            type: string
          type: array
        group:
          type: string
      required:
        - facilityRefs
        - group
      title: AssignedGroup
      type: object
      description: AssignedGroup
    AssignedRequiredLineItem:
      properties:
        quantity:
          description: >-
            Id matching service data line item where this assigned required line
            item is assigned from
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minimum: 0
          type: integer
        serviceDataLineItemId:
          description: assigned quantity of the items
          example: 12
          minimum: 0
          minLength: 1
          type: string
      required:
        - quantity
        - serviceDataLineItemId
      title: AssignedRequiredLineItem
      type: object
      description: AssignedRequiredLineItem
    AssignedRoles:
      properties:
        context:
          description: The context limitations of the assigned role
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 50
          type: array
        contextLimitations:
          deprecated: true
          description: The context limitations of the assigned role (deprecated)
          items:
            $ref: '#/components/schemas/ContextLimitation'
          type: array
        ref:
          description: The id of the assigned role
          type: string
      required:
        - ref
      title: AssignedRoles
      type: object
      description: AssignedRoles
    AssignedUser:
      properties:
        userId:
          description: ID of the user who is assigned
          type: string
        username:
          description: username of the user who is assigned
          type: string
      required:
        - username
        - userId
      type: object
      title: AssignedUser
      description: AssignedUser
    AssignedUserForCreationById:
      description: Create a assigned user by giving a valid id
      properties:
        userId:
          description: userId of the user should be assigned
          type: string
      required:
        - userId
      title: AssignedUserForCreationById
      type: object
    AssignedUserForCreationByName:
      description: Create a assigned user by giving a valid name
      properties:
        username:
          description: username of the user should be assigned
          type: string
      required:
        - username
      title: AssignedUserForCreationByName
      type: object
    AssignFacilityToProcess:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value to manually assign a facility to a process
              enum:
                - AssignFacilityToProcess
              type: string
            facilityRef:
              type: string
            rerouteDescriptionId:
              type: string
          required:
            - action
            - facilityRef
          type: object
      description: Action to assign a process to a facility.
      title: AssignFacilityToProcessAction
      xml:
        name: AssignFacilityToProcess
    AssignFacilityToProcessActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractProcessActionsParameter'
      description: Action to assign a facility to a process.
      properties:
        facilityRef:
          type: string
        name:
          enum:
            - ASSIGN_FACILITY_TO_PROCESS
          type: string
        rerouteDescriptionId:
          type: string
      required:
        - name
        - version
        - facilityRef
      title: AssignFacilityToProcessActionParameter
    AssignmentItem:
      properties:
        articleTitle:
          type: string
        quantity:
          type: number
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - quantity
      title: AssignmentItem
      description: AssignmentItem
    Audit:
      properties:
        actor:
          $ref: '#/components/schemas/AuditActor'
        anonymizationDate:
          format: date-time
          type: string
        client:
          $ref: '#/components/schemas/AuditClient'
        created:
          description: Creation date of the entity, auto-generated if not provided
          format: date-time
          type: string
        deletionDate:
          format: date-time
          type: string
        entityCreated:
          format: date-time
          type: string
        entityRef:
          type: string
        entityType:
          enum:
            - PACK_JOB
            - PICK_JOB
            - PICK_RUN
            - HANDOVER_JOB
            - SHIPMENT
            - PARCEL
            - CUSTOM_SERVICE
            - SERVICE_JOB
            - LINKED_SERVICE_JOBS
            - ORDER
            - ROUTING_PLAN
            - FACILITY
            - FACILITY_GROUP
            - FACILITY_CARRIER_CONNECTION
            - FACILITY_CUSTOM_SERVICE
            - ROUTING_STRATEGY
            - STOW_JOB
          type: string
        entityVersion:
          type: number
        eventId:
          type: string
        globalActor:
          $ref: '#/components/schemas/AuditActor'
        id:
          type: string
        isAnonymized:
          type: boolean
        lastModified:
          description: Service-generated last modification date of the entity
          format: date-time
          type: string
        operation:
          $ref: '#/components/schemas/AuditOperation'
        trace:
          type: string
        version:
          description: The version of the entity, used for optimistic locking mechanisms
          example: 1
          type: number
      required:
        - id
        - eventId
        - entityRef
        - entityType
        - entityVersion
        - isAnonymized
        - entityCreated
        - deletionDate
        - anonymizationDate
        - trace
        - actor
        - globalActor
        - client
        - operation
        - version
      title: Audit
      type: object
      description: Audit
    AuditActor:
      properties:
        details:
          $ref: '#/components/schemas/AuditActorDetails'
        id:
          type: string
      required:
        - id
        - details
      title: AuditActor
      type: object
      description: AuditActor
    AuditActorDetails:
      properties:
        topic:
          type: string
        username:
          type: string
      required:
        - topic
        - username
      title: AuditActorDetails
      type: object
      description: AuditActorDetails
    AuditClient:
      properties:
        api:
          type: string
        rawInfo:
          type: string
      required:
        - api
        - rawInfo
      title: AuditClient
      type: object
      description: AuditClient
    AuditedEntityTypeEnumFilter:
      properties:
        eq:
          description: Search by entityType
          enum:
            - PACK_JOB
            - PICK_JOB
            - PICK_RUN
            - HANDOVER_JOB
            - SHIPMENT
            - PARCEL
            - CUSTOM_SERVICE
            - SERVICE_JOB
            - LINKED_SERVICE_JOBS
            - ORDER
            - ROUTING_PLAN
            - FACILITY
            - FACILITY_GROUP
            - FACILITY_CARRIER_CONNECTION
            - FACILITY_CUSTOM_SERVICE
            - ROUTING_STRATEGY
            - STOW_JOB
          type: string
        in:
          description: Search by entityType
          items:
            enum:
              - PACK_JOB
              - PICK_JOB
              - PICK_RUN
              - HANDOVER_JOB
              - SHIPMENT
              - PARCEL
              - CUSTOM_SERVICE
              - SERVICE_JOB
              - LINKED_SERVICE_JOBS
              - ORDER
              - ROUTING_PLAN
              - FACILITY
              - FACILITY_GROUP
              - FACILITY_CARRIER_CONNECTION
              - FACILITY_CUSTOM_SERVICE
              - ROUTING_STRATEGY
              - STOW_JOB
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by entityType
          enum:
            - PACK_JOB
            - PICK_JOB
            - PICK_RUN
            - HANDOVER_JOB
            - SHIPMENT
            - PARCEL
            - CUSTOM_SERVICE
            - SERVICE_JOB
            - LINKED_SERVICE_JOBS
            - ORDER
            - ROUTING_PLAN
            - FACILITY
            - FACILITY_GROUP
            - FACILITY_CARRIER_CONNECTION
            - FACILITY_CUSTOM_SERVICE
            - ROUTING_STRATEGY
            - STOW_JOB
          type: string
      title: AuditedEntityTypeEnumFilter
      type: object
      description: AuditedEntityTypeEnumFilter
    AuditOperation:
      properties:
        name:
          type: string
        start:
          format: date-time
          type: string
      required:
        - name
        - start
      title: AuditOperation
      type: object
      description: AuditOperation
    AuditPaginatedResult:
      properties:
        audits:
          items:
            $ref: '#/components/schemas/Audit'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - audits
      title: AuditPaginatedResult
      type: object
      description: AuditPaginatedResult
    AuditSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/AuditSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/AuditSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: AuditSearchPayload
      type: object
      description: AuditSearchPayload
    AuditSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/AuditSearchQuery'
          maxItems: 500
          type: array
        entityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by entityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        entityType:
          allOf:
            - $ref: '#/components/schemas/AuditedEntityTypeEnumFilter'
          description: Search by entityType
        or:
          items:
            $ref: '#/components/schemas/AuditSearchQuery'
          maxItems: 500
          type: array
        trace:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by trace
      title: AuditSearchQuery
      type: object
      description: AuditSearchQuery
    AuditSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
      title: AuditSort
      type: object
      description: AuditSort
    AuditsResult:
      properties:
        audits:
          description: The audits that match the filter criteria
          items:
            $ref: '#/components/schemas/Audit'
          type: array
        total:
          description: The total number of audits that match the filter criteria
          minimum: 0
          type: number
      required:
        - audits
        - total
      title: AuditsResult
      type: object
      description: AuditsResult
    AuthenticationProvider:
      properties:
        id:
          description: The id of the authentication provider
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/AuthenticationProviderTypeEnum'
          description: The type of the authentication provider
      required:
        - type
      title: AuthenticationProvider
      type: object
      description: AuthenticationProvider
    AuthenticationProviderTypeEnum:
      description: The type of the authentication provider
      enum:
        - EMAIL_PASSWORD
        - OIDC
        - SUPPORT_ACCESS
      title: AuthenticationProviderTypeEnum
      type: string
    AvailabilityAllocation:
      properties:
        channelRef:
          type: string
        created:
          format: date-time
          type: string
        facilityRef:
          type: string
        groupRef:
          type: string
        id:
          type: string
        initialStockQuantity:
          type: number
        lastModified:
          format: date-time
          type: string
        version:
          type: number
      required:
        - facilityRef
        - initialStockQuantity
        - groupRef
        - channelRef
        - id
        - version
        - created
        - lastModified
      title: AvailabilityAllocation
      type: object
      description: AvailabilityAllocation
    AvailabilityAllocationForCreationUnderGroup:
      properties:
        facilityRef:
          type: string
        initialStockQuantity:
          type: number
      required:
        - facilityRef
        - initialStockQuantity
      title: AvailabilityAllocationForCreationUnderGroup
      type: object
      description: AvailabilityAllocationForCreationUnderGroup
    AvailabilityAllocationForReplacement:
      properties:
        groupId:
          type: string
        initialStockQuantity:
          type: number
        version:
          type: number
      required:
        - version
        - initialStockQuantity
      title: AvailabilityAllocationForReplacement
      type: object
      description: AvailabilityAllocationForReplacement
    AvailabilityAllocationGroup:
      properties:
        active:
          type: boolean
        activePeriod:
          $ref: '#/components/schemas/AvailabilityAllocationPeriod'
        channelRef:
          type: string
        created:
          format: date-time
          type: string
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        tenantArticleIds:
          items:
            type: string
          maxItems: 1
          type: array
        version:
          type: number
      required:
        - tenantArticleIds
        - active
        - channelRef
        - id
        - version
        - created
        - lastModified
      title: AvailabilityAllocationGroup
      type: object
      description: AvailabilityAllocationGroup
    AvailabilityAllocationGroupForCreationUnderChannel:
      properties:
        active:
          type: boolean
        activePeriod:
          $ref: '#/components/schemas/AvailabilityAllocationPeriod'
        tenantArticleIds:
          items:
            type: string
          maxItems: 1
          type: array
      required:
        - tenantArticleIds
        - active
      title: AvailabilityAllocationGroupForCreationUnderChannel
      type: object
      description: AvailabilityAllocationGroupForCreationUnderChannel
    AvailabilityAllocationGroupForReplacement:
      properties:
        active:
          type: boolean
        activePeriod:
          $ref: '#/components/schemas/AvailabilityAllocationPeriod'
        version:
          type: number
      required:
        - version
        - active
      title: AvailabilityAllocationGroupForReplacement
      type: object
      description: AvailabilityAllocationGroupForReplacement
    AvailabilityAllocationGroupPaginatedResult:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/AvailabilityAllocationGroup'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - groups
      title: AvailabilityAllocationGroupPaginatedResult
      type: object
      description: AvailabilityAllocationGroupPaginatedResult
    AvailabilityAllocationPaginatedResult:
      properties:
        allocations:
          items:
            $ref: '#/components/schemas/AvailabilityChannel'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - allocations
      title: AvailabilityAllocationPaginatedResult
      type: object
      description: AvailabilityAllocationPaginatedResult
    AvailabilityAllocationPeriod:
      properties:
        end:
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        start:
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      title: AvailabilityAllocationPeriod
      type: object
      description: AvailabilityAllocationPeriod
    AvailabilityChannel:
      properties:
        created:
          format: date-time
          type: string
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        name:
          type: string
        strategy:
          enum:
            - REGULAR
            - IRON_RESERVE
            - RESTRICT
          type: string
        version:
          type: number
      required:
        - name
        - strategy
        - version
        - id
        - created
        - lastModified
      title: AvailabilityChannel
      type: object
      description: AvailabilityChannel
    AvailabilityChannelForCreation:
      properties:
        name:
          type: string
        strategy:
          enum:
            - REGULAR
            - IRON_RESERVE
            - RESTRICT
          type: string
      required:
        - name
        - strategy
      title: AvailabilityChannelForCreation
      type: object
      description: AvailabilityChannelForCreation
    AvailabilityChannelForReplacement:
      properties:
        name:
          type: string
        strategy:
          enum:
            - REGULAR
            - IRON_RESERVE
            - RESTRICT
          type: string
        version:
          type: number
      required:
        - name
        - strategy
        - version
      title: AvailabilityChannelForReplacement
      type: object
      description: AvailabilityChannelForReplacement
    AvailabilityChannelPaginatedResult:
      properties:
        channels:
          items:
            $ref: '#/components/schemas/AvailabilityChannel'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - channels
      title: AvailabilityChannelPaginatedResult
      type: object
      description: AvailabilityChannelPaginatedResult
    AvailabilityDuringRerouteStock:
      properties:
        pickedQuantity:
          type: number
        rerouteReason:
          $ref: '#/components/schemas/RerouteReason'
      title: AvailabilityDuringRerouteStock
      description: AvailabilityDuringRerouteStock
    AvailabilityDuringRouting:
      properties:
        articleTitle:
          type: string
        available:
          type: number
        availablePostRerouteAdjustment:
          type: number
        bundleInformation:
          items:
            $ref: '#/components/schemas/BundleInformation'
          type: array
        isBackOrderable:
          default: false
          type: boolean
        preOrderDate:
          format: date-time
          type: string
        requestedQuantity:
          type: number
        rerouteInformation:
          $ref: '#/components/schemas/AvailabilityDuringRerouteStock'
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - requestedQuantity
        - available
        - isBackOrderable
      title: AvailabilityDuringRouting
      description: AvailabilityDuringRouting
    AvailabilityTimeframe:
      properties:
        start:
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      type: object
      title: AvailabilityTimeframe
      description: AvailabilityTimeframe
    AvailabilityTimeframe2:
      properties:
        start:
          type: string
      required:
        - start
      title: AvailabilityTimeframe2
      type: object
      description: AvailabilityTimeframe2
    AvailableDecisionReasons:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        context:
          description: Context in which this reason is available
          items:
            $ref: '#/components/schemas/DecisionReasonContext'
          maxItems: 10
          minItems: 1
          type: array
        reason:
          description: Translated value from  reasonLocalized
          example: Item damaged
          type: string
      required:
        - reasonLocalized
      title: AvailableDecisionReasons
      type: object
      description: AvailableDecisionReasons
    AvailableForPickingDetails:
      properties:
        total:
          type: number
      required:
        - total
      title: AvailableForPickingDetails
      type: object
      description: AvailableForPickingDetails
    AvailableItemCondition:
      properties:
        conditionLocalized:
          $ref: '#/components/schemas/LocaleString'
      required:
        - conditionLocalized
      title: AvailableItemCondition
      type: object
      description: AvailableItemCondition
    AvailableOperativeProcessAction:
      properties:
        available:
          description: Indicates whether the action is available for this operative process
          type: boolean
        denyReasons:
          description: List of reasons why the action is not available
          items:
            $ref: '#/components/schemas/AvailableOperativeProcessActionDenyReason'
          type: array
        name:
          description: Name of the operative process action
          enum:
            - REJECT_OPERATIVE_PROCESS
            - MANIPULATE_LINE_ITEM_QUANTITY
            - CHANGE_POSTAL_ADDRESS
            - ADD_TARGET_TIME
          type: string
      required:
        - name
        - available
        - denyReasons
      title: AvailableOperativeProcessAction
      type: object
      description: AvailableOperativeProcessAction
    AvailableOperativeProcessActionDenyReason:
      properties:
        errorCode:
          description: Error code indicating the reason why the action is not available
          enum:
            - PICKING_STARTED
            - TRANSFER_HAPPENED
            - HANDOVER_DONE
            - TARGET_TIME_ALREADY_SET
          type: string
        message:
          description: Human-readable message describing the deny reason
          type: string
      required:
        - errorCode
        - message
      title: AvailableOperativeProcessActionDenyReason
      type: object
      description: AvailableOperativeProcessActionDenyReason
    AvailableOperativeProcessActions:
      properties:
        actions:
          description: List of available actions for the operative process
          items:
            $ref: '#/components/schemas/AvailableOperativeProcessAction'
          type: array
      required:
        - actions
      title: AvailableOperativeProcessActions
      type: object
      description: AvailableOperativeProcessActions
    AvailableRefusedReason:
      additionalProperties: false
      properties:
        refusedReasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          type: boolean
        refusedReason:
          description: translated refusedReason selected from refusedReasonLocalized
          example: Broken Item
          type: string
      required:
        - refusedReasonLocalized
        - active
      type: object
      title: AvailableRefusedReason
      description: AvailableRefusedReason
    AvailableRefuseReasonForCreation:
      additionalProperties: false
      properties:
        refusedReasonLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
        active:
          example: true
          type: boolean
      required:
        - active
        - refusedReasonLocalized
      type: object
      title: AvailableRefuseReasonForCreation
      description: AvailableRefuseReasonForCreation
    AvailableRefuseReasonForUpdate:
      additionalProperties: false
      properties:
        refusedReasonLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
        active:
          example: true
          type: boolean
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: number
      required:
        - active
        - refusedReasonLocalized
        - version
      type: object
      title: AvailableRefuseReasonForUpdate
      description: AvailableRefuseReasonForUpdate
    AvailableReturnReason:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        identifier:
          description: >-
            Small identifier to be displayed and printed. Allowed values are
            1-99 and A-Z. Needs to be unique respecting all other reasons. If
            not set, an ascending will be chosen automatically
          example: A
          type: string
      required:
        - reasonLocalized
      title: AvailableReturnReason
      type: object
      description: AvailableReturnReason
    AvailableUntilCalculationBase:
      description: >-
        The base for the calculation of the available until date. If it can't be
        resolved into a valid date (i.e. missing expiry value), an undefined
        "availableUntil" is the result
      enum:
        - EXPIRY
        - CREATION
      type: string
      xml:
        name: AvailableUntilCalculationBase
      title: AvailableUntilCalculationBase
    AvailableUntilDefinition:
      properties:
        calculationBase:
          $ref: '#/components/schemas/AvailableUntilCalculationBase'
        modifier:
          description: >-
            Moves the calculated date by the given period, defined in ISO-8601
            duration notation. Use negative values to move the date backwards.
            Example: "-P30D" places the "availableUntil" value 30 days before
            the calculated date.
          example: '-P30D'
          pattern: ^-?P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
      required:
        - calculationBase
      title: AvailableUntilDefinition
      description: AvailableUntilDefinition
    BackofficePickingConfiguration:
      description: Can this tenant use the backoffice for picking?
      properties:
        active:
          default: false
          type: boolean
      required:
        - active
      type: object
      title: BackofficePickingConfiguration
    Backordered:
      properties:
        lineItems:
          items:
            $ref: '#/components/schemas/DeliveryPromiseLineItem'
          type: array
      required:
        - lineItems
      type: object
      title: Backordered
      description: Backordered
    BaseDecisionDetail:
      properties:
        decisionType:
          $ref: '#/components/schemas/DecisionType'
      required:
        - decisionType
      title: BaseDecisionDetail
      description: BaseDecisionDetail
    BaseOperationalContainer:
      properties:
        sequenceNumber:
          description: >-
            Incremental number to distinguish containers of the same type.
            Virtual container's sequenceNumber is always 0, non virtual
            containers are always greater than 0.
          example: 100
          format: int32
          maximum: 10000
          minimum: 0
          type: integer
      type: object
      title: BaseOperationalContainer
      description: BaseOperationalContainer
    BaseValidation:
      properties:
        validationType:
          enum:
            - STRING
            - FLOAT
            - INTEGER
          type: string
      required:
        - validationType
      type: object
      title: BaseValidation
      description: BaseValidation
    BasicDeliveryPromiseShipment:
      additionalProperties: false
      properties:
        facility:
          $ref: '#/components/schemas/BasicDeliveryPromiseShipmentFacility'
        lineItems:
          items:
            $ref: '#/components/schemas/DeliveryPromiseLineItem'
          type: array
      required:
        - lineItems
        - facility
      type: object
      xml:
        name: DeliveryPromiseShipment
      title: BasicDeliveryPromiseShipment
      description: BasicDeliveryPromiseShipment
    BasicDeliveryPromiseShipmentFacility:
      additionalProperties: false
      properties:
        facilityName:
          type: string
        facilityRef:
          type: string
        tenantFacilityId:
          type: string
      required:
        - facilityName
        - facilityRef
      title: BasicDeliveryPromiseShipmentFacility
      description: BasicDeliveryPromiseShipmentFacility
    BasketItem:
      properties:
        quantity:
          description: Quantity
          example: 42
          type: integer
        tenantArticleId:
          description: Tenant article ID
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
        - quantity
      title: BasketItem
      type: object
      description: BasketItem
    BatchPickingConfiguration:
      additionalProperties: false
      properties:
        maxAmountOfPickJobsForBatchPick:
          description: >-
            The maximum amount of pick jobs that can be combined in a batch
            pick. Must be a value between 1 and 100.
          maximum: 100
          minimum: 1
          type: integer
      required:
        - maxAmountOfPickJobsForBatchPick
      type: object
      title: BatchPickingConfiguration
      description: BatchPickingConfiguration
    BinPackerInput:
      properties:
        currency:
          description: ISO 4217 currency code
          example: EUR
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]{3}$
          type: string
        lineItems:
          description: List of articles and quantities to pack
          items:
            $ref: '#/components/schemas/BinPackerInputOrderLine'
          minItems: 1
          type: array
        packagingUnitDetailRefs:
          description: List of packaging unit detail references to consider for packing
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          minItems: 1
          type: array
        sourceFacilityRef:
          description: Reference to the source facility
          example: FACILITY-001
          type: string
        targetCountryCode:
          description: ISO 3166-1 alpha-2 country code of the target location
          example: DE
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        targetPostalCode:
          description: Postal code of the target location
          example: '10115'
          nullable: true
          type: string
      required:
        - lineItems
        - packagingUnitDetailRefs
        - sourceFacilityRef
        - targetCountryCode
        - currency
      title: BinPackerInput
      type: object
      description: BinPackerInput
    BinPackerInputOrderLine:
      properties:
        quantity:
          description: Number of items of this article to pack
          example: 5
          minimum: 1
          type: number
        tenantArticleId:
          description: Unique identifier for the article within the tenant
          example: ARTICLE-001
          type: string
      required:
        - tenantArticleId
        - quantity
      title: BinPackerInputOrderLine
      type: object
      description: BinPackerInputOrderLine
    BooleanFilter:
      properties:
        eq:
          type: boolean
        notEq:
          type: boolean
      title: BooleanFilter
      type: object
      description: BooleanFilter
    Brand:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/BrandForCreation'
      properties:
        id:
          example: fsfdsf87fsd
          type: string
        name:
          description: The name of the brand for this listing
          example: Adidas
          type: string
      required:
        - name
        - id
      type: object
      xml:
        name: Brand
      title: Brand
      description: Brand
    BrandForCreation:
      properties:
        name:
          description: The name of the brand for this listing
          example: Adidas
          type: string
      required:
        - name
      type: object
      xml:
        name: BrandForCreation
      title: BrandForCreation
      description: BrandForCreation
    BringCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        customerId:
          description: Customer ID for Bring carrier
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        returnProduct:
          description: Return product code
          type: string
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        shipmentProduct:
          description: Shipment product code
          type: string
        supportPhoneNumber:
          description: Support phone number
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
        webhookFftHost:
          description: Webhook FFT host
          type: string
      required:
        - version
        - carrierRef
        - returnLabel
        - customerId
        - supportPhoneNumber
      title: BringCarrierConfiguration
      type: object
      description: BringCarrierConfiguration
    BulkForceCancelOrderParameter:
      properties:
        cancelationReasonId:
          description: ID of the cancellation reason
          type: string
        orderId:
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - orderId
        - version
      type: object
      title: BulkForceCancelOrderParameter
      description: BulkForceCancelOrderParameter
    BulkOperationError:
      properties:
        message:
          type: string
        type:
          enum:
            - NOT_FOUND
            - NOT_ALLOWED
            - VALIDATION
            - UNKNOWN
          type: string
      required:
        - type
        - message
      title: BulkOperationError
      type: object
      description: BulkOperationError
    BulkOperationResultStatus:
      enum:
        - UPDATED
        - UNCHANGED
        - CREATED
        - FAILED
      type: string
      title: BulkOperationResultStatus
      description: BulkOperationResultStatus
    BulkOrderActionResult:
      properties:
        orderId:
          type: string
        status:
          $ref: '#/components/schemas/BulkOperationResultStatus'
        summary:
          type: string
      required:
        - orderId
        - status
      type: object
      title: BulkOrderActionResult
      description: BulkOrderActionResult
    BulkOrderActionsParameter:
      oneOf:
        - $ref: '#/components/schemas/BulkOrderForceCancelActionParameter'
      title: BulkOrderActionsParameter
      description: BulkOrderActionsParameter
    BulkOrderForceCancelActionParameter:
      description: Action to force cancel orders.
      properties:
        name:
          enum:
            - BULK_FORCE_CANCEL
          type: string
        orders:
          items:
            $ref: '#/components/schemas/BulkForceCancelOrderParameter'
          maxItems: 15
          minItems: 1
          type: array
      required:
        - name
        - orders
      title: BulkOrderForceCancelActionParameter
    BulkUpsertSummary:
      properties:
        created:
          description: The number of operations that led to an insertion
          type: number
        unchanged:
          description: The number of operations that led to no change
          type: number
        updated:
          description: The number of operations that led to an update
          example: 2026-06-17T12:00:00.000Z
          type: number
      required:
        - created
        - updated
        - unchanged
      title: BulkUpsertSummary
      type: object
      description: BulkUpsertSummary
    BulkyGoodsDetails:
      properties:
        maxGirth:
          description: The maximum girth in millimeters of the packagingUnit.
          type: number
        maxItemQuantity:
          description: The maximum number of items that can fit in the packagingUnit.
          type: number
        maxLength:
          description: The maximum length in millimeters of the packagingUnit.
          type: number
        maxWeight:
          description: The maximum weight in grams that the packagingUnit can hold.
          type: number
        packagingPricingDetails:
          $ref: '#/components/schemas/PackagingPricingDetails'
        type:
          description: The type of the packagingUnit.
          enum:
            - PALLET
            - TWO_MAN_HANDLING
            - PARCEL
            - BULKY_GOODS
          type: string
        volumeBufferInPercent:
          description: The volume buffer in percent for the packagingUnit.
          type: number
      required:
        - type
        - maxLength
        - maxGirth
        - maxWeight
        - packagingPricingDetails
      title: BulkyGoodsDetails
      type: object
      description: BulkyGoodsDetails
    BundleInformation:
      properties:
        customServiceNodeId:
          type: string
        requestedQuantity:
          type: number
      required:
        - customServiceNodeId
        - requestedQuantity
      title: BundleInformation
      description: BundleInformation
    ByTrait:
      properties:
        ACCESSIBLE:
          type: number
        PICKABLE:
          type: number
      required:
        - PICKABLE
        - ACCESSIBLE
      title: ByTrait
      type: object
      description: ByTrait
    CalculatedPurchasePrice:
      properties:
        discount:
          description: The discount applied to the purchase price
          oneOf:
            - $ref: '#/components/schemas/FacilityDiscountRelative'
            - $ref: '#/components/schemas/FacilityDiscountAbsolute'
        discountedPurchasePrice:
          allOf:
            - $ref: '#/components/schemas/PurchasePrice'
          description: Discounted purchase price for the listing.
        purchasePrice:
          allOf:
            - $ref: '#/components/schemas/PurchasePrice'
          description: purchase price information for the listing.
        supplierFacilityRef:
          description: The reference of the supplier facility.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - supplierFacilityRef
        - purchasePrice
        - discountedPurchasePrice
      title: CalculatedPurchasePrice
      type: object
      description: CalculatedPurchasePrice
    CallbackHeader:
      description: Header for the Webhook call.
      properties:
        key:
          description: 'This is the key of the header. e.g.: `Authorization`'
          type: string
        value:
          description: >-
            This is the value for the header. e.g.: `Basic
            dXNlcm5hbWU6cGFzc3dvcmQ=`
          type: string
      required:
        - key
        - value
      title: CallbackHeader
      type: object
    CancelationReason:
      allOf:
        - $ref: '#/components/schemas/AbstractReason'
      properties:
        action:
          enum:
            - CANCELATION
          type: string
      required:
        - action
      type: object
      xml:
        name: CancelationReason
      title: CancelationReason
      description: CancelationReason
    CancelationReasonForCreation:
      allOf:
        - $ref: '#/components/schemas/AbstractReasonForCreation'
      type: object
      xml:
        name: CancelationReasonForCreation
      title: CancelationReasonForCreation
      description: CancelationReasonForCreation
    CancelationReasonForModification:
      allOf:
        - $ref: '#/components/schemas/AbstractReasonForModification'
      type: object
      xml:
        name: CancelationReasonForModification
      title: CancelationReasonForModification
      description: CancelationReasonForModification
    CancelationReasonHistoryLog:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        id:
          type: string
        reason:
          type: string
        version:
          type: number
      required:
        - id
        - version
      type: object
      title: CancelationReasonHistoryLog
      description: CancelationReasonHistoryLog
    CancelationReasons:
      allOf:
        - $ref: '#/components/schemas/AbstractReasons'
      properties:
        reasons:
          items:
            $ref: '#/components/schemas/CancelationReason'
          type: array
      required:
        - reasons
      type: object
      xml:
        name: CancelationReasons
      title: CancelationReasons
      description: CancelationReasons
    CancelHandoverjob:
      additionalProperties: false
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/handoverjobs/:id/actions instead
      properties:
        action:
          $ref: '#/components/schemas/CancelHandoverjobActionEnum'
        handoverJobCancelReason:
          $ref: '#/components/schemas/HandoverJobCancelReason'
      required:
        - action
        - handoverJobCancelReason
      title: CancelHandoverjob
      type: object
      xml:
        name: CancelHandoverjob
    CancelHandoverjobActionEnum:
      enum:
        - CancelHandoverjob
      type: string
      title: CancelHandoverjobActionEnum
      description: CancelHandoverjobActionEnum
    CancelItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - CancelItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: CancelItemReturnActionParameter
      type: object
      description: CancelItemReturnActionParameter
    CancelPickRun:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: Use value 'CancelPickRun', because you want to cancel a pickrun
              enum:
                - CancelPickRun
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/pickruns/:id/actions instead
      title: CancelPickRun
      xml:
        name: CancelPickRun
    CancelStowJobAction:
      description: Sets the status of the stowjob to CANCELED
      properties:
        name:
          description: The name of the action that should be performed
          enum:
            - CANCEL_STOW_JOB
          type: string
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
      title: CancelStowJobAction
      type: object
    CapabilityStatus:
      enum:
        - enabled
        - inactive
        - disabled
      type: string
      title: CapabilityStatus
      description: CapabilityStatus
    CapacityPlanningTimeframeConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        days:
          default: 100
          description: >-
            The range in days per facility which defines how many days in the
            future the capacity of the facility can be planned
          example: '240'
          minimum: 1
          type: integer
        id:
          type: string
      required:
        - days
      type: object
      title: CapacityPlanningTimeframeConfiguration
      description: CapacityPlanningTimeframeConfiguration
    Carrier:
      properties:
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        credentials:
          allOf:
            - $ref: '#/components/schemas/AbstractCarrierCredentials'
          description: Credentials for the carrier
        defaultParcelHeightInCm:
          default: 10
          description: Default height in cm
          example: 10
          minimum: 1
          type: number
        defaultParcelLengthInCm:
          default: 25
          description: Default length in cm
          example: 25
          minimum: 1
          type: number
        defaultParcelWeightInGram:
          default: 1000
          description: Default weight for a parcel in gram
          example: 1000
          minimum: 1
          type: number
        defaultParcelWidthInCm:
          default: 35
          description: Default width in cm
          example: 35
          minimum: 1
          type: number
        deliveryType:
          description: 'Provided delivery of this CEP. Default: DELIVERY'
          enum:
            - SAMEDAY
            - DELIVERY
          type: string
        id:
          description: The id of the carrier
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        key:
          description: >-
            References the KEP. Currently allowed values are DHL_V2, DPD_CH,
            DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD,
            DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers
            one can use CUSTOM_ combined with a unique name.
          example: DHL_V2
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        lifecycle:
          description: >-
            Used to determine if a carrier is available for configuration. GA
            carriers are generally available and are covered by our SLA. BETA
            carriers are available, but subject to change and not covered by
            SLA. ALPHA carriers are not implemented completely, yet. Default: GA
          enum:
            - GA
            - BETA
            - ALPHA
          type: string
        logoUrl:
          description: URL of the carrier logo
          example: https://example.com/resource
          minLength: 1
          type: string
        name:
          description: >-
            This is the well known name for a supported CEP partner. Can be
            adapted to the clients needs.
          example: DHL Köln
          type: string
        parcelLabelClassifications:
          description: Parcel label classifications for this carrier
          items:
            $ref: '#/components/schemas/ParcelLabelClassification'
          type: array
        productValueNeeded:
          description: >-
            Setting to enable the Client to ask for the parcel product value
            while ordering a label. This information is mandatory for sending
            parcels between different countries (customs declaration)
          example: true
          type: boolean
        status:
          description: 'It is taken into consideration for all carriers. Default: INACTIVE'
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - id
        - version
        - key
        - name
        - defaultParcelWidthInCm
        - defaultParcelLengthInCm
        - defaultParcelHeightInCm
      title: Carrier
      type: object
      description: Carrier
    CarrierChangedCarrierInfo:
      properties:
        carrierKey:
          type: string
        carrierRef:
          type: string
      type: object
      title: CarrierChangedCarrierInfo
      description: CarrierChangedCarrierInfo
    CarrierChangedPayload:
      allOf:
        - $ref: '#/components/schemas/OperativeEntityPayloadBase'
      properties:
        newCarrier:
          $ref: '#/components/schemas/CarrierChangedCarrierInfo'
        previousCarrier:
          $ref: '#/components/schemas/CarrierChangedCarrierInfo'
      type: object
      title: CarrierChangedPayload
      description: CarrierChangedPayload
    CarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: CarrierConfiguration
      type: object
      description: CarrierConfiguration
    CarrierCountryServiceMapping:
      properties:
        additionalShippingArticleAttributes:
          description: >-
            Article Attributes that will be displayed in the client as
            additional. They are not mandatory but could benefit the process.
          items:
            $ref: '#/components/schemas/AdditionalShippingArticleAttribute'
          maxItems: 20
          type: array
        additionalShippingAttributes:
          description: >-
            Shipping Attributes that will be displayed in the client as
            additional. They are not mandatory but could benefit the process.
          items:
            $ref: '#/components/schemas/AdditionalShippingAttribute'
          maxItems: 30
          type: array
        carrierProductCategory:
          description: Desired product class to choose when ordering a label
          enum:
            - STANDARD
            - EXPRESS
            - VALUE
            - FORWARDING
          type: string
        carrierServices:
          description: Services which can be provided by the carrier
          items:
            enum:
              - SIGNATURE
              - CUSTOMER_SIGNATURE
              - ADULT_SIGNATURE
              - SATURDAY_DELIVERY
              - IDENTITY_CHECK_COMPANY
              - IDENTITY_CHECK_PRIVATE
              - ADDITIONAL_TRANSPORTATION_INSURANCE
              - IDENTITY_AGE_CHECK_18
              - NO_NEIGHBOR_DELIVERY
              - HANDOVER_TO_RECIPIENT_ONLY
            type: string
          maxItems: 10
          type: array
        countAsTransitDayBefore:
          description: Time before which this day counts as a transit day
          example: '12:00'
          type: string
        deliveryCosts:
          description: Delivery costs for this mapping
          items:
            $ref: '#/components/schemas/DeliveryCost'
          maxItems: 1
          type: array
        destinationCountries:
          deprecated: true
          description: deprecated - Use destinations instead.
          items:
            type: string
          maxItems: 250
          type: array
        destinations:
          description: The destination regions this mapping should be applied to.
          items:
            $ref: '#/components/schemas/RegionInformation'
          maxItems: 250
          type: array
        id:
          description: Unique identifier for a countryServiceMapping
          example: bc5b581a-8f65-45b0-9f81-6e0d4babbcb2
          type: string
        mandatoryShippingArticleAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingArticleAttribute'
          maxItems: 20
          type: array
        mandatoryShippingAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingAttribute'
          maxItems: 30
          type: array
        mandatoryShippingItemAttributes:
          deprecated: true
          description: Deprecated - use mandatoryShippingArticleAttributes instead
          items:
            $ref: '#/components/schemas/MandatoryShippingItemAttribute'
          maxItems: 30
          type: array
        products:
          description: Array of products for the given mapping
          items:
            type: string
          maxItems: 50
          type: array
        source:
          allOf:
            - $ref: '#/components/schemas/RegionInformation'
          description: Source region for this mapping
        sourceCountry:
          deprecated: true
          description: deprecated - Use source instead.
          example: DE
          type: string
        staticCCSMRef:
          description: Reference to a static country service mapping
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        transitTime:
          allOf:
            - $ref: '#/components/schemas/CarrierTransitTime'
          description: Transit time configuration for this mapping
          example: 2026-06-17T12:00:00.000Z
      required:
        - id
        - source
        - destinations
      title: CarrierCountryServiceMapping
      type: object
      description: CarrierCountryServiceMapping
    CarrierCountryServiceMappingForCreation:
      properties:
        additionalShippingArticleAttributes:
          description: >-
            Article Attributes that will be displayed in the client as
            additional. They are not mandatory but could benefit the process.
            Mandatory fields can not be additional. If duplicates found, the
            additional values will be removed on read.
          items:
            $ref: '#/components/schemas/AdditionalShippingArticleAttribute'
          minItems: 0
          type: array
        additionalShippingAttributes:
          description: >-
            Shipping Attributes that will be displayed in the client as
            additional. They are not mandatory but could benefit the process.
            Mandatory fields can not be additional If duplicates found, the
            additional values will be removed on read.
          items:
            $ref: '#/components/schemas/AdditionalShippingAttribute'
          minItems: 0
          type: array
        carrierConfigurationVersion:
          description: >-
            The version of the carrier configuration to be used in optimistic
            locking mechanisms.
          example: 1
          format: int64
          type: integer
        carrierProductCategory:
          description: Desired product class to choose when ordering a label
          enum:
            - STANDARD
            - EXPRESS
            - VALUE
            - FORWARDING
          type: string
        countAsTransitDayBefore:
          description: Time before which this day counts as a transit day
          type: string
        deliveryCosts:
          description: Delivery costs for this mapping
          items:
            $ref: '#/components/schemas/DeliveryCost'
          maxItems: 1
          minItems: 1
          type: array
        destinationCountries:
          deprecated: true
          description: deprecated - Use destination instead.
          items:
            type: string
          minItems: 1
          type: array
        destinations:
          description: The destination regions this mapping should be applied to.
          items:
            $ref: '#/components/schemas/RegionInformation'
          minItems: 1
          type: array
        mandatoryShippingArticleAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingArticleAttribute'
          minItems: 0
          type: array
        mandatoryShippingAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingAttribute'
          minItems: 0
          type: array
        mandatoryShippingItemAttributes:
          deprecated: true
          description: Deprecated - use mandatoryShippingArticleAttributes instead
          items:
            $ref: '#/components/schemas/MandatoryShippingItemAttribute'
          minItems: 0
          type: array
        products:
          description: Products for this mapping
          items:
            type: string
          type: array
        source:
          allOf:
            - $ref: '#/components/schemas/RegionInformation'
          description: Source region for this mapping
        sourceCountry:
          deprecated: true
          description: deprecated - Use source instead.
          maxLength: 2
          minLength: 2
          type: string
        transitTime:
          allOf:
            - $ref: '#/components/schemas/CarrierTransitTime'
          description: Transit time configuration for this mapping
          example: 2026-06-17T12:00:00.000Z
      required:
        - carrierConfigurationVersion
        - source
        - destinations
      title: CarrierCountryServiceMappingForCreation
      type: object
      description: CarrierCountryServiceMappingForCreation
    CarrierCountryServiceMappingForUpdate:
      properties:
        additionalShippingArticleAttributes:
          description: >-
            Article Attributes that will be displayed in the client as
            additional. They are not mandatory but could benefit the process.
            Mandatory fields can not be additional. If duplicates found, the
            additional values will be removed on read.
          items:
            $ref: '#/components/schemas/AdditionalShippingArticleAttribute'
          minItems: 0
          type: array
        additionalShippingAttributes:
          description: >-
            Shipping Attributes that will be displayed in the client as
            additional. They are not mandatory but could benefit the process.
            Mandatory fields can not be additional If duplicates found, the
            additional values will be removed on read.
          items:
            $ref: '#/components/schemas/AdditionalShippingAttribute'
          minItems: 0
          type: array
        carrierConfigurationVersion:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 1
          format: int64
          type: integer
        carrierProductCategory:
          description: Desired product class to choose when ordering a label
          enum:
            - STANDARD
            - EXPRESS
            - VALUE
            - FORWARDING
          type: string
        countAsTransitDayBefore:
          description: Time before which this day counts as a transit day
          type: string
        deliveryCosts:
          description: Delivery costs for this mapping
          items:
            $ref: '#/components/schemas/DeliveryCost'
          maxItems: 1
          type: array
        destinationCountries:
          deprecated: true
          description: deprecated - Use destination instead.
          items:
            type: string
          minItems: 1
          type: array
        destinations:
          description: The destination regions this mapping should be applied to.
          items:
            $ref: '#/components/schemas/RegionInformation'
          minItems: 1
          type: array
        mandatoryShippingArticleAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingArticleAttribute'
          minItems: 0
          type: array
        mandatoryShippingAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingAttribute'
          minItems: 0
          type: array
        mandatoryShippingItemAttributes:
          deprecated: true
          description: Deprecated - use mandatoryShippingArticleAttributes instead
          items:
            $ref: '#/components/schemas/MandatoryShippingItemAttribute'
          minItems: 0
          type: array
        products:
          description: Array of products for the given mapping
          items:
            type: string
          type: array
        source:
          allOf:
            - $ref: '#/components/schemas/RegionInformation'
          description: Source region for this mapping
        sourceCountry:
          deprecated: true
          description: deprecated - Use source instead.
          maxLength: 2
          minLength: 2
          type: string
        transitTime:
          allOf:
            - $ref: '#/components/schemas/CarrierTransitTime'
          description: Transit time configuration for this mapping
          example: 2026-06-17T12:00:00.000Z
      required:
        - carrierConfigurationVersion
      title: CarrierCountryServiceMappingForUpdate
      type: object
      description: CarrierCountryServiceMappingForUpdate
    CarrierCutoffConfiguration:
      properties:
        capacity:
          type: number
        time:
          example: '12:00'
          pattern: ^(2[0-3]|[01]?[0-9]):([0-5]?[0-9])$
          type: string
      required:
        - time
      type: object
      xml:
        name: CarrierCutoffTimes
      title: CarrierCutoffConfiguration
      description: CarrierCutoffConfiguration
    CarrierCutoffTimes:
      nullable: true
      properties:
        overwrites:
          items:
            $ref: '#/components/schemas/CarrierCutoffTimesOverwrite'
          type: array
        weekdays:
          items:
            $ref: '#/components/schemas/CarrierCutoffTimesWeekDay'
          type: array
      required:
        - weekdays
        - overwrites
      type: object
      xml:
        name: CarrierCutoffTimes
      title: CarrierCutoffTimes
      description: CarrierCutoffTimes
    CarrierCutoffTimesOverwrite:
      properties:
        cutoffConfigurations:
          items:
            $ref: '#/components/schemas/CarrierCutoffConfiguration'
          type: array
        date:
          example: 2020-02-03T00:00:00.000Z
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
      required:
        - date
        - cutoffConfigurations
      type: object
      xml:
        name: CarrierCutoffTimes
      title: CarrierCutoffTimesOverwrite
      description: CarrierCutoffTimesOverwrite
    CarrierCutoffTimesWeekDay:
      properties:
        cutoffConfigurations:
          items:
            $ref: '#/components/schemas/CarrierCutoffConfiguration'
          type: array
        day:
          $ref: '#/components/schemas/WeekDay'
      required:
        - day
        - cutoffConfigurations
      type: object
      xml:
        name: CarrierCutoffTimesWeekDay
      title: CarrierCutoffTimesWeekDay
      description: CarrierCutoffTimesWeekDay
    CarrierDeliveryType:
      enum:
        - SAMEDAY
        - DELIVERY
      type: string
      title: CarrierDeliveryType
      description: CarrierDeliveryType
    CarrierForCreation:
      properties:
        credentials:
          allOf:
            - $ref: '#/components/schemas/AbstractCarrierCredentials'
          description: Credentials for the carrier
        defaultParcelHeightInCm:
          default: 10
          description: Default height in cm
          example: 10
          minimum: 1
          type: number
        defaultParcelLengthInCm:
          default: 25
          description: Default length in cm
          example: 25
          minimum: 1
          type: number
        defaultParcelWeightInGram:
          default: 1000
          description: Default weight for a parcel in gram
          example: 1000
          minimum: 1
          type: number
        defaultParcelWidthInCm:
          default: 35
          description: Default width in cm
          example: 35
          minimum: 1
          type: number
        key:
          description: >-
            References the KEP. Currently allowed values are DHL_V2, DPD_CH,
            DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD,
            DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers
            one can use CUSTOM_ combined with a unique name.
          example: DHL_V2
          type: string
        logoUrl:
          description: URL of the carrier logo
          example: https://example.com/resource
          minLength: 1
          type: string
        name:
          description: >-
            This is the well known name for a supported CEP partner. Can be
            adapted to the clients needs.
          example: DHL Köln
          type: string
        parcelLabelClassifications:
          description: Parcel label classifications for this carrier
          items:
            $ref: '#/components/schemas/ParcelLabelClassificationForCreation'
          type: array
        productValueNeeded:
          description: >-
            Setting to enable the Client to ask for the parcel product value
            while ordering a label. This information is mandatory for sending
            parcels between different countries (customs declaration)
          example: true
          type: boolean
        status:
          description: 'It is taken into consideration for all carriers. Default: INACTIVE'
          enum:
            - ACTIVE
            - INACTIVE
          type: string
      required:
        - key
        - name
      title: CarrierForCreation
      type: object
      description: CarrierForCreation
    CarrierPatchActions:
      properties:
        actions:
          description: Array of modification actions to apply to the carrier
          items:
            $ref: '#/components/schemas/ModifyCarrier'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 1
          format: int64
          type: integer
      required:
        - actions
        - version
      title: CarrierPatchActions
      type: object
      description: CarrierPatchActions
    CarrierPickUpTime:
      properties:
        end:
          allOf:
            - $ref: '#/components/schemas/TimeStamp'
          description: End time of the pick up window
        start:
          allOf:
            - $ref: '#/components/schemas/TimeStamp'
          description: Start time of the pick up window
      required:
        - start
        - end
      title: CarrierPickUpTime
      type: object
      description: CarrierPickUpTime
    CarrierPriorityCalculationRequest:
      properties:
        productValue:
          $ref: '#/components/schemas/ParcelProductValue'
          description: Product value information used to calculate carrier priority
      title: CarrierPriorityCalculationRequest
      type: object
      description: CarrierPriorityCalculationRequest
    CarrierPriorityResult:
      properties:
        otherCarriers:
          description: Other eligible carriers ordered by priority
          items:
            $ref: '#/components/schemas/CarrierRecommendationResult'
          type: array
        recommendedCarriers:
          description: Recommended carriers ordered by priority (best first)
          items:
            $ref: '#/components/schemas/CarrierRecommendationResult'
          type: array
      required:
        - recommendedCarriers
        - otherCarriers
      title: CarrierPriorityResult
      type: object
      description: CarrierPriorityResult
    CarrierProductCategory:
      enum:
        - STANDARD
        - EXPRESS
        - VALUE
        - FORWARDING
      type: string
      title: CarrierProductCategory
      description: CarrierProductCategory
    CarrierRecipientInformation:
      properties:
        address:
          description: >-
            Addresses of the recipients for this carrierRecipientInformation.
            Depending on the use case there can be multiple recipient addresses
            (e.g. invoice address deviates from shipping address).
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 3
          minItems: 1
          type: array
        id:
          description: >-
            Addresses of the recipients for this carrierRecipientInformation.
            Depending on the use case there can be multiple recipient addresses
            (e.g. invoice address deviates from shipping address).
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - id
        - address
      title: CarrierRecipientInformation
      type: object
      description: CarrierRecipientInformation
    CarrierRecipientInformationForCreation:
      properties:
        address:
          description: >-
            Addresses of the recipients for this carrierRecipientInformation.
            Depending on the use case there can be multiple recipient addresses
            (e.g. invoice address deviates from shipping address).
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 3
          minItems: 1
          type: array
      required:
        - address
      title: CarrierRecipientInformationForCreation
      type: object
      description: CarrierRecipientInformationForCreation
    CarrierRecommendationResult:
      properties:
        carrier:
          $ref: '#/components/schemas/Carrier'
          description: Carrier that is recommended
        priority:
          description: Calculated priority value (lower typically indicates a better match)
          example: 42
          type: number
        threshold:
          $ref: '#/components/schemas/PriceRange'
          description: Applicable price threshold for this recommendation
      required:
        - priority
        - carrier
      title: CarrierRecommendationResult
      type: object
      description: CarrierRecommendationResult
    CarrierService:
      properties:
        type:
          description: Service type identifier
          type: string
      required:
        - type
      title: CarrierService
      type: object
      description: CarrierService
    CarrierServices:
      enum:
        - SIGNATURE
        - CUSTOMER_SIGNATURE
        - ADULT_SIGNATURE
        - SATURDAY_DELIVERY
        - IDENTITY_CHECK_COMPANY
        - IDENTITY_CHECK_PRIVATE
        - ADDITIONAL_TRANSPORTATION_INSURANCE
        - IDENTITY_AGE_CHECK_18
        - NO_NEIGHBOR_DELIVERY
        - HANDOVER_TO_RECIPIENT_ONLY
      type: string
      title: CarrierServices
      description: CarrierServices
    CarrierStatus:
      description: 'It is taken into consideration for all carriers. Default: INACTIVE'
      enum:
        - ACTIVE
        - INACTIVE
      type: string
      title: CarrierStatus
    CarrierTrackingStatus:
      additionalProperties: false
      description: Native trackingStatus provided by carrier
      properties:
        description:
          description: Description of the status
          example: Parcel has been delivered
          type: string
        status:
          description: Status of the parcel as provided by carrier
          example: DELIVERED
          type: string
        timestamp:
          description: Timestamp this status was set by the carrier
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
      required:
        - status
      type: object
      title: CarrierTrackingStatus
    CarrierTransitTime:
      properties:
        maxTransitDays:
          description: Maximum days a carrier needs for transit
          example: 3
          format: int32
          minimum: 0
          type: number
        minTransitDays:
          description: Minimum days a carrier needs for transit
          example: 1
          format: int32
          minimum: 0
          type: number
      required:
        - minTransitDays
        - maxTransitDays
      title: CarrierTransitTime
      type: object
      description: CarrierTransitTime
    Category:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleStringConstrained'
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        tenantCategoryId:
          description: unique identifier for categories used in the customer systems
          example: MY_CATEGORY_ID
          maxLength: 256
          minLength: 2
          pattern: ^[A-Za-z0-9_-]+$
          type: string
        version:
          type: number
      required:
        - nameLocalized
        - version
        - created
        - lastModified
      title: Category
      type: object
      description: Category
    CategoryForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleStringConstrained'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        tenantCategoryId:
          description: unique identifier for categories used in the customer systems
          example: MY_CATEGORY_ID
          maxLength: 256
          minLength: 2
          pattern: ^[A-Za-z0-9_-]+$
          type: string
      required:
        - nameLocalized
      title: CategoryForCreation
      type: object
      description: CategoryForCreation
    CategoryForUpdate:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleStringConstrained'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        tenantCategoryId:
          description: unique identifier for categories used in the customer systems
          example: MY_CATEGORY_ID
          maxLength: 256
          minLength: 2
          pattern: ^[A-Za-z0-9_-]+$
          type: string
        version:
          type: number
      required:
        - nameLocalized
        - version
      title: CategoryForUpdate
      type: object
      description: CategoryForUpdate
    CategoryPaginatedResult:
      properties:
        categories:
          items:
            $ref: '#/components/schemas/Category'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - categories
      title: CategoryPaginatedResult
      type: object
      description: CategoryPaginatedResult
    CategorySearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/CategorySearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/CategorySort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: CategorySearchPayload
      type: object
      description: CategorySearchPayload
    CategorySearchQuery:
      properties:
        nameLocalized:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/StringFilter'
              - $ref: '#/components/schemas/KeyExistsFilter'
          description: Search by nameLocalized
          type: object
        and:
          items:
            $ref: '#/components/schemas/CategorySearchQuery'
          maxItems: 500
          type: array
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        name:
          allOf:
            - $ref: '#/components/schemas/LocalizedStringSearchFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/CategorySearchQuery'
          maxItems: 500
          type: array
        tenantCategoryId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantCategoryId
          example: MY_CATEGORY_ID
      title: CategorySearchQuery
      type: object
      description: CategorySearchQuery
    CategorySort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        id:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        name:
          enum:
            - ASC
            - DESC
          type: string
        tenantCategoryId:
          enum:
            - ASC
            - DESC
          type: string
      title: CategorySort
      type: object
      description: CategorySort
    ChangeLineItemsToNotReturnableInItemReturnJobActionParameter:
      properties:
        lineItemIds:
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        name:
          enum:
            - CHANGE_LINE_ITEMS_TO_NOT_RETURNABLE_IN_ITEM_RETURN_JOB
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - version
        - name
        - lineItemIds
      title: ChangeLineItemsToNotReturnableInItemReturnJobActionParameter
      type: object
      description: ChangeLineItemsToNotReturnableInItemReturnJobActionParameter
    ChangeLineItemsToReturnableInItemReturnJobActionParameter:
      properties:
        lineItemIds:
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        name:
          enum:
            - CHANGE_LINE_ITEMS_TO_RETURNABLE_IN_ITEM_RETURN_JOB
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - version
        - name
        - lineItemIds
      title: ChangeLineItemsToReturnableInItemReturnJobActionParameter
      type: object
      description: ChangeLineItemsToReturnableInItemReturnJobActionParameter
    ChannelStockAvailability:
      properties:
        availableForPicking:
          type: number
        availableOnStock:
          type: number
        channelRef:
          type: string
      required:
        - channelRef
        - availableForPicking
        - availableOnStock
      title: ChannelStockAvailability
      type: object
      description: ChannelStockAvailability
    CheckoutOptionsAvailability:
      properties:
        available:
          description: Available quantity
          example: 42
          type: number
        carrier:
          allOf:
            - $ref: '#/components/schemas/CheckoutOptionsAvailabilityCarrier'
          description: Carrier details
        isBackOrderable:
          description: Is item back-orderable
          example: true
          type: boolean
        latestPickingStart:
          description: Latest picking start
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        preOrderReleaseDate:
          description: Pre-order release date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        tenantArticleId:
          description: Tenant article ID
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
        - available
        - isBackOrderable
      title: CheckoutOptionsAvailability
      type: object
      description: CheckoutOptionsAvailability
    CheckoutOptionsAvailabilityCarrier:
      properties:
        carrierProductCategory:
          description: Carrier product category
          enum:
            - STANDARD
            - EXPRESS
            - VALUE
            - FORWARDING
          type: string
        carrierRef:
          description: Carrier reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - carrierRef
      title: CheckoutOptionsAvailabilityCarrier
      type: object
      description: CheckoutOptionsAvailabilityCarrier
    CheckoutOptionsCollectEarliestRequest:
      properties:
        desiredCollectDate:
          description: Desired collection date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        facilities:
          description: >-
            List of facilities for collection. Each item must contain exactly
            one of facilityRef or tenantFacilityRef.
          items:
            oneOf:
              - $ref: >-
                  #/components/schemas/CheckoutOptionsCollectFacilitiesFacilityRef
              - $ref: >-
                  #/components/schemas/CheckoutOptionsCollectFacilitiesTenantFacilityRef
          type: array
        includeCalculationHints:
          description: Whether to include calculation hints in the response
          example: true
          type: boolean
        tenantArticleIds:
          description: List of tenant article IDs
          items:
            type: string
          minItems: 1
          type: array
      required:
        - tenantArticleIds
      title: CheckoutOptionsCollectEarliestRequest
      type: object
      description: CheckoutOptionsCollectEarliestRequest
    CheckoutOptionsCollectEarliestResponse:
      properties:
        calculationHints:
          description: Calculation hints
          items:
            type: string
          type: array
        checkoutOptions:
          description: Checkout options per article for collection
          items:
            $ref: '#/components/schemas/CheckoutOptionsCollectEarliestResponseItem'
          type: array
      required:
        - checkoutOptions
      title: CheckoutOptionsCollectEarliestResponse
      type: object
      description: CheckoutOptionsCollectEarliestResponse
    CheckoutOptionsCollectEarliestResponseItem:
      properties:
        available:
          description: Available quantity
          example: 42
          type: number
        earliestPredictedProvisioningDate:
          description: Earliest predicted provisioning date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        facilityRef:
          description: Facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStartDate:
          description: Latest picking start date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        tenantArticleId:
          description: Tenant article ID
          example: MY_ARTICLE_ID
          type: string
        tenantFacilityId:
          description: Tenant facility ID
          example: MY_FACILITY_ID
          type: string
      required:
        - tenantArticleId
      title: CheckoutOptionsCollectEarliestResponseItem
      type: object
      description: CheckoutOptionsCollectEarliestResponseItem
    CheckoutOptionsCollectFacilitiesFacilityRef:
      properties:
        facilityRef:
          description: Facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - facilityRef
      title: CheckoutOptionsCollectFacilitiesFacilityRef
      type: object
      description: CheckoutOptionsCollectFacilitiesFacilityRef
    CheckoutOptionsCollectFacilitiesTenantFacilityRef:
      properties:
        tenantFacilityRef:
          description: Tenant facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - tenantFacilityRef
      title: CheckoutOptionsCollectFacilitiesTenantFacilityRef
      type: object
      description: CheckoutOptionsCollectFacilitiesTenantFacilityRef
    CheckoutOptionsConsumerAddress:
      properties:
        addressType:
          description: Type of address
          enum:
            - POSTAL_ADDRESS
            - PARCEL_LOCKER
            - INVOICE_ADDRESS
          type: string
        city:
          description: City name
          example: Yellowstone
          type: string
        country:
          description: Country code
          example: DE
          type: string
        houseNumber:
          description: House number
          example: 42
          type: string
        postalCode:
          description: Postal code
          example: '42420'
          type: string
        province:
          description: Province or state
          type: string
        street:
          description: Street name
          type: string
      required:
        - country
      title: CheckoutOptionsConsumerAddress
      type: object
      description: CheckoutOptionsConsumerAddress
    CheckoutOptionsCustomServices:
      properties:
        customServiceRef:
          description: Custom service reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        name:
          description: Custom service name
          type: string
      required:
        - customServiceRef
        - name
      title: CheckoutOptionsCustomServices
      type: object
      description: CheckoutOptionsCustomServices
    CheckoutOptionsDeliveryEarliestRequest:
      properties:
        consumerAddress:
          allOf:
            - $ref: '#/components/schemas/CheckoutOptionsConsumerAddress'
          description: Consumer delivery address
        earliestDeliveryDate:
          description: Earliest delivery date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        filter:
          allOf:
            - $ref: '#/components/schemas/CheckoutOptionsFacilityFilter'
          description: Facility filter criteria
        includeCalculationHints:
          description: Whether to include calculation hints in the response
          example: true
          type: boolean
        includeListingDetails:
          description: >-
            Indicates whether listing-related details should be included in the
            response. If set to `true`, the response contains additional listing
            details. Defaults to `false`.
          type: boolean
        tenantArticleIds:
          description: List of tenant article IDs
          items:
            type: string
          minItems: 1
          type: array
      required:
        - consumerAddress
        - tenantArticleIds
      title: CheckoutOptionsDeliveryEarliestRequest
      type: object
      description: CheckoutOptionsDeliveryEarliestRequest
    CheckoutOptionsDeliveryEarliestResponse:
      properties:
        calculationHints:
          description: Calculation hints for debugging
          items:
            type: string
          type: array
        checkoutOptions:
          description: List of checkout options for each article
          items:
            $ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestResponseItem'
          type: array
      required:
        - checkoutOptions
      title: CheckoutOptionsDeliveryEarliestResponse
      type: object
      description: CheckoutOptionsDeliveryEarliestResponse
    CheckoutOptionsDeliveryEarliestResponseItem:
      properties:
        availableCarriers:
          description: Available carriers for delivery
          items:
            $ref: >-
              #/components/schemas/CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier
          type: array
        availableFacilityConnections:
          description: Available facility connections
          items:
            $ref: >-
              #/components/schemas/CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection
          type: array
        earliestPredictedDeliveryDate:
          description: Earliest predicted delivery date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        listingDetails:
          description: Listing details
          items:
            $ref: '#/components/schemas/CheckoutOptionsListingDetails'
          type: array
        tenantArticleId:
          description: Tenant article ID
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
      title: CheckoutOptionsDeliveryEarliestResponseItem
      type: object
      description: CheckoutOptionsDeliveryEarliestResponseItem
    CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier:
      properties:
        carrierRef:
          description: Carrier reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStartDate:
          description: Latest picking start date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        name:
          description: Carrier name
          type: string
        nonDeliveryDays:
          description: Non-delivery days
          items:
            type: string
          type: array
      required:
        - carrierRef
        - name
      title: CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier
      type: object
      description: CheckoutOptionsDeliveryEarliestResponseItemAvailableCarrier
    CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection:
      properties:
        connectionRef:
          description: Connection reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStartDate:
          description: Latest picking start date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        nonDeliveryDays:
          description: Non-delivery days
          items:
            type: string
          type: array
      required:
        - connectionRef
      title: CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection
      type: object
      description: CheckoutOptionsDeliveryEarliestResponseItemAvailableConnection
    CheckoutOptionsDeliveryTimePeriodRequest:
      properties:
        basket:
          description: Basket items
          items:
            $ref: '#/components/schemas/BasketItem'
          type: array
        consumerAddress:
          allOf:
            - $ref: '#/components/schemas/CheckoutOptionsConsumerAddress'
          description: Consumer delivery address
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferencesShipping'
        endDate:
          description: End date-time of the period
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        includeCalculationHints:
          description: Whether to include calculation hints in the response
          example: true
          type: boolean
        startDate:
          description: Start date-time of the period
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      required:
        - basket
        - consumerAddress
      title: CheckoutOptionsDeliveryTimePeriodRequest
      type: object
      description: CheckoutOptionsDeliveryTimePeriodRequest
    CheckoutOptionsDeliveryTimePeriodResponse:
      properties:
        calculationHints:
          description: Calculation hints
          items:
            type: string
          type: array
        checkoutOptions:
          description: Checkout options across the requested period
          items:
            $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItem'
          type: array
      required:
        - checkoutOptions
      title: CheckoutOptionsDeliveryTimePeriodResponse
      type: object
      description: CheckoutOptionsDeliveryTimePeriodResponse
    CheckoutOptionsDeliveryTimePeriodResponseItem:
      properties:
        availableCarriers:
          description: Available carriers for the date
          items:
            $ref: >-
              #/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier
          type: array
        availableFacilityConnections:
          description: Available facility connections for the date
          items:
            $ref: >-
              #/components/schemas/CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection
          type: array
        date:
          description: Date of the option
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        overallStatus:
          description: Overall availability status for the date
          enum:
            - ALL
            - PARTIAL
            - NONE
          type: string
      required:
        - overallStatus
        - date
      title: CheckoutOptionsDeliveryTimePeriodResponseItem
      type: object
      description: CheckoutOptionsDeliveryTimePeriodResponseItem
    CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier:
      properties:
        carrierRef:
          description: Carrier reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStartDate:
          description: Latest picking start date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        name:
          description: Carrier name
          type: string
        nonDeliveryDays:
          description: Non-delivery days
          items:
            type: string
          type: array
      required:
        - carrierRef
        - name
      title: CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier
      type: object
      description: CheckoutOptionsDeliveryTimePeriodResponseItemAvailableCarrier
    CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection:
      properties:
        connectionRef:
          description: Connection reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStartDate:
          description: Latest picking start date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        nonDeliveryDays:
          description: Non-delivery days
          items:
            type: string
          type: array
      required:
        - connectionRef
      title: CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection
      type: object
      description: CheckoutOptionsDeliveryTimePeriodResponseItemAvailableConnection
    CheckoutOptionsDeliveryTimePointRequest:
      properties:
        desiredDeliveryDate:
          description: Desired delivery date-time
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        facilities:
          description: Facilities with latest picking start constraints
          items:
            $ref: '#/components/schemas/FacilityRefLatestPickingStartPair'
          type: array
        tenantArticleIds:
          description: Tenant article IDs
          items:
            type: string
          type: array
      required:
        - desiredDeliveryDate
        - tenantArticleIds
        - facilities
      title: CheckoutOptionsDeliveryTimePointRequest
      type: object
      description: CheckoutOptionsDeliveryTimePointRequest
    CheckoutOptionsDeliveryTimePointResponse:
      properties:
        items:
          description: Availability per article and facility
          items:
            $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointResponseItem'
          type: array
      required:
        - items
      title: CheckoutOptionsDeliveryTimePointResponse
      type: object
      description: CheckoutOptionsDeliveryTimePointResponse
    CheckoutOptionsDeliveryTimePointResponseItem:
      properties:
        available:
          description: Available quantity
          example: 42
          type: number
        facilityRef:
          description: Facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStart:
          description: Latest picking start date-time
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        tenantArticleId:
          description: Tenant article ID
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
        - available
        - facilityRef
      title: CheckoutOptionsDeliveryTimePointResponseItem
      type: object
      description: CheckoutOptionsDeliveryTimePointResponseItem
    CheckoutOptionsFacilityFilter:
      properties:
        customAttributes:
          description: Custom attributes for facility filtering
          type: object
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      title: CheckoutOptionsFacilityFilter
      type: object
      description: CheckoutOptionsFacilityFilter
    CheckoutOptionsFacilityForCNC:
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddress'
        availabilities:
          description: Article availabilities
          items:
            $ref: '#/components/schemas/CheckoutOptionsAvailability'
          type: array
        closingDays:
          items:
            $ref: '#/components/schemas/ClosingDay'
          type: array
        customServices:
          description: Custom services
          items:
            $ref: '#/components/schemas/CheckoutOptionsCustomServices'
          type: array
        facilityRef:
          description: Facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        name:
          description: Facility name
          type: string
        pickingTimes:
          $ref: '#/components/schemas/PickingTimes'
        targetTime:
          description: Target time for collection
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      required:
        - facilityRef
        - name
        - address
        - closingDays
        - pickingTimes
        - availabilities
        - customServices
        - targetTime
      title: CheckoutOptionsFacilityForCNC
      type: object
      description: CheckoutOptionsFacilityForCNC
    CheckoutOptionsFacilityForSFS:
      properties:
        availabilities:
          description: Article availabilities
          items:
            $ref: '#/components/schemas/CheckoutOptionsAvailability'
          type: array
        customServices:
          description: Custom services
          items:
            $ref: '#/components/schemas/CheckoutOptionsCustomServices'
          type: array
        deliveryOptions:
          items:
            $ref: '#/components/schemas/PromiseCarrier'
          type: array
        facilityRef:
          description: Facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        name:
          description: Facility name
          type: string
      required:
        - facilityRef
        - name
        - availabilities
        - deliveryOptions
        - customServices
      title: CheckoutOptionsFacilityForSFS
      type: object
      description: CheckoutOptionsFacilityForSFS
    CheckoutOptionsInput:
      properties:
        consumerAddress:
          allOf:
            - $ref: '#/components/schemas/CheckoutOptionsConsumerAddress'
          description: Consumer address
        customAttributes:
          additionalProperties: true
          description: Custom attributes for filtering
          type: object
        customServices:
          items:
            $ref: '#/components/schemas/CustomServiceReference'
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
          description: Delivery preferences
        filterDuplicates:
          description: Filter duplicate facilities
          example: true
          type: boolean
        geoFence:
          $ref: '#/components/schemas/GeoFence'
          description: Geofence restrictions
        orderLineItems:
          description: Order line items
          items:
            type: object
          type: array
        tags:
          description: Tags
          items:
            type: object
          type: array
      required:
        - deliveryPreferences
        - orderLineItems
      title: CheckoutOptionsInput
      type: object
      description: CheckoutOptionsInput
    CheckoutOptionsListingDetails:
      properties:
        customAttributes:
          additionalProperties: true
          description: Custom attributes associated with the listing
          type: object
        facilityRef:
          description: Facility reference of the listing
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantFacilityId:
          description: Tenant facility id of the listing
          example: MY_FACILITY_ID
          type: string
      required:
        - facilityRef
        - tenantFacilityId
      title: CheckoutOptionsListingDetails
      type: object
      description: CheckoutOptionsListingDetails
    ClickAndCollectRerouteConfiguration:
      properties:
        active:
          type: boolean
        rerouteType:
          $ref: '#/components/schemas/RerouteType'
      required:
        - active
      type: object
      title: ClickAndCollectRerouteConfiguration
      description: ClickAndCollectRerouteConfiguration
    ClientNotificationChannel:
      properties:
        enabled:
          type: boolean
        events:
          description: >-
            Supported events for triggering external notifications:
            PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE,
            ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED,
            ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED,
            ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.
          items:
            enum:
              - PICK_JOB_CREATED
              - UPCOMING_TIME_TRIGGERED_REROUTE
              - ROUTING_PLAN_NOT_ROUTABLE
              - ROUTING_PLAN_WAITING
              - ORDER_MODIFIED
              - ORDER_UNLOCKED
              - LOCKED_ORDER_CREATED
              - ORDER_FORCE_CANCELLED
              - ORDER_CANCELLED_BY_EXPIRY
              - ORDER_CANCELLED
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        id:
          type: string
        type:
          enum:
            - CLIENT
          type: string
      required:
        - enabled
        - events
        - type
        - id
      title: ClientNotificationChannel
      type: object
      description: ClientNotificationChannel
    ClientNotificationChannelForCreation:
      properties:
        enabled:
          type: boolean
        events:
          description: >-
            Supported events for triggering external notifications:
            PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE,
            ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED,
            ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED,
            ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.
          items:
            enum:
              - PICK_JOB_CREATED
              - UPCOMING_TIME_TRIGGERED_REROUTE
              - ROUTING_PLAN_NOT_ROUTABLE
              - ROUTING_PLAN_WAITING
              - ORDER_MODIFIED
              - ORDER_UNLOCKED
              - LOCKED_ORDER_CREATED
              - ORDER_FORCE_CANCELLED
              - ORDER_CANCELLED_BY_EXPIRY
              - ORDER_CANCELLED
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        type:
          enum:
            - CLIENT
          type: string
      required:
        - enabled
        - events
        - type
      title: ClientNotificationChannelForCreation
      type: object
      description: ClientNotificationChannelForCreation
    CloseStowJobAction:
      description: Sets the status of the stowjob to CLOSED
      properties:
        name:
          description: The name of the action that should be performed
          enum:
            - CLOSE_STOW_JOB
          type: string
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
      title: CloseStowJobAction
      type: object
    ClosingDay:
      description: At this day the facility is closed and does not do picking
      properties:
        date:
          description: The day at which the Facility is closed
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        reason:
          description: The reason why the Facility is closed on this day
          type: string
        recurrence:
          enum:
            - YEARLY
            - NONRECURRING
          type: string
      required:
        - reason
        - date
        - recurrence
      type: object
      title: ClosingDay
    CollectDelivery:
      anyOf:
        - required:
            - facilityRef
        - required:
            - tenantFacilityId
      properties:
        facilityRef:
          description: >-
            Reference to the facility where the consumer expects to collect the
            items
          type: string
        paid:
          default: false
          description: Indicates if the order is already paid.
          type: boolean
        provisioningTime:
          description: The point in time by which the order is supposed to be provisioned.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        supplyingFacilities:
          deprecated: true
          description: '@deprecated Use supplyingFacilitiesConfigurations'
          items:
            description: Reference of a Facility.
            example: 928f3730-bc48-4d85-b83f-3fd86b776178
            type: string
          maxItems: 500
          type: array
        supplyingFacilitiesConfigurations:
          description: >-
            References of facility that could supply contents of the order to
            another facility with specific configuration of its usage
          items:
            $ref: '#/components/schemas/SupplyingFacilityConfiguration'
          maxItems: 500
          type: array
        tenantFacilityId:
          description: >-
            Reference to the facility where the consumer expects to collect the
            items.
          type: string
      type: object
      title: CollectDelivery
      description: CollectDelivery
    CombinedCostRatingConfiguration:
      allOf:
        - $ref: '#/components/schemas/AbstractRatingConfiguration'
      description: >-
        This rating configuration is used to calculate the rating based on the
        total sales prices and/or the total shipping costs of the order line
        items. At least one of the cost components must be selected.
      properties:
        totalSalesPrices:
          default: false
          description: >-
            >- If set to true, the total sales prices of the order line items
            are used for the calculation of the rating.
          type: boolean
        totalShippingCosts:
          default: false
          description: >-
            If set to true, the total shipping costs of the order line items are
            used for the calculation of the rating."
          type: boolean
        type:
          $ref: '#/components/schemas/RatingConfigurationType'
      title: CombinedCostRatingConfiguration
    CompanyAddress:
      properties:
        city:
          example: Langenfeld
          pattern: ^.+$
          type: string
        country:
          example: Germany
          pattern: ^.+$
          type: string
        houseNumber:
          example: 42a
          pattern: ^.+$
          type: string
        name:
          example: OC fulfillment GmbH
          pattern: ^.+$
          type: string
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      required:
        - name
        - street
        - postalCode
        - city
        - country
      type: object
      title: CompanyAddress
      description: CompanyAddress
    ConditionWorkflowNode:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowNameLocaleString'
          description: Localized name of the node
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowDescriptionLocaleString'
          description: Localized description of the node
        condition:
          allOf:
            - $ref: '#/components/schemas/WorkflowCondition'
          description: >-
            Condition expression that determines the path. Connections from this
            node must use .TRUE or .FALSE suffixes
        description:
          description: Description resolved to the requesting user's locale (read-only)
          type: string
        key:
          description: Unique identifier for this node within the workflow
          type: string
        name:
          description: Name resolved to the requesting user's locale (read-only)
          type: string
        type:
          description: Type of the workflow node
          enum:
            - CONDITION
          type: string
      required:
        - key
        - type
        - condition
      title: ConditionWorkflowNode
      type: object
      description: ConditionWorkflowNode
    ConnectAppTypeEnum:
      description: The type of possible Apps
      enum:
        - PICKING
        - INVENTORY
        - OPERATIONS_ANDROID
        - OPERATIONS_IOS
        - STORE_OPERATIONS_IOS
        - STORE_OPERATIONS_ANDROID
      example: PICKING
      type: string
      title: ConnectAppTypeEnum
    ConnectionRefusedAnalysis:
      properties:
        containsInvalidContexts:
          description: Indicates whether invalid contexts were found.
          type: boolean
        containsInvalidTargets:
          description: Indicates whether invalid targets were found.
          type: boolean
        containsValidConnections:
          description: Indicates whether valid connections exist.
          type: boolean
      required:
        - containsValidConnections
        - containsInvalidTargets
        - containsInvalidContexts
      title: ConnectionRefusedAnalysis
      type: object
      description: ConnectionRefusedAnalysis
    ConnectionsAnalysisResult:
      properties:
        canBeIntermediateHop:
          allOf:
            - $ref: '#/components/schemas/ConnectionRefusedAnalysis'
          description: >-
            Analysis of connections from the graph to the lookup facility (layer
            1 or 2).
        canSupplyIntermediateHop:
          allOf:
            - $ref: '#/components/schemas/ConnectionRefusedAnalysis'
          description: Analysis of lookup facility as potential layer 0 (supplier).
        canSupplyTarget:
          allOf:
            - $ref: '#/components/schemas/ConnectionRefusedAnalysis'
          description: Analysis of connections from the lookup facility to the target.
      required:
        - canSupplyIntermediateHop
        - canBeIntermediateHop
        - canSupplyTarget
      title: ConnectionsAnalysisResult
      type: object
      description: ConnectionsAnalysisResult
    ConnectionType:
      enum:
        - SUPPLIER
        - MANAGED_FACILITY
        - CUSTOMER
      type: string
      title: ConnectionType
      description: ConnectionType
    ConsolidatedRoutingPlanStatus:
      description: |-
        This status consolidates many of the RoutingPlanStatus and offers
        a more detailes explanation of what happened to the routing plan.
      enum:
        - REROUTED
        - MANUALLY_REROUTED
        - ORDER_MODIFIED_REROUTED
        - PROCESS_ORDER_MODIFIED_REROUTED_THEN_NOT_ROUTABLE
        - PROCESS_ORDER_MODIFIED_REROUTED_THEN_REROUTED_AND_SPLIT
        - PROCESS_ORDER_MODIFIED_REROUTED_THEN_ROUTED
        - ROUTED
        - ROUTED_THEN_REROUTED
        - PROCESS_MANUAL_REROUTED_THEN_ROUTED
        - PROCESS_MANUAL_REROUTED_THEN_NOT_ROUTABLE
        - PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT
        - ROUTING_PLAN_REROUTED_THEN_ROUTED_TO_SAME_FACILITY
        - ROUTING_PLAN_SHORTPICKED_THEN_ROUTED_TO_SAME_FACILITY
        - ROUTING_PLAN_CREATED_THEN_ROUTING
        - ROUTING_PLAN_CREATED_THEN_PLANNED
        - ROUTING_PLAN_REROUTED_THEN_FAILED
        - FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED
        - FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED
        - STOCK_UPDATE_RECEIVED_THEN_REACTIVATED
        - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED
        - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT
        - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED
        - ROUTING_PLAN_SHORTPICKED_THEN_SPLIT
        - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT
        - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED
        - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_AND_SPLIT
        - ROUTING_PLAN_REROUTE_STOCK_ZERO_THEN_REROUTED_TO_SAME_FACILITY
        - PICKJOB_REJECTED_THEN_REROUTED
        - PICKJOB_REJECTED_THEN_NOT_ROUTABLE
        - PICKJOB_REJECTED_THEN_ROUTED_AND_SPLIT
        - ROUTED_AND_SPLIT
        - OBSOLETE
        - OBSOLETE_WAS_MANUALLY_REROUTED
        - OBSOLETE_WAS_MANUALLY_ASSIGNED
        - OBSOLETE_WAS_SHORTPICKED
        - OBSOLETE_WAS_ROUTED
        - UNKNOWN
        - RETRYABLE
        - FAILED_REROUTE
        - ROUTED_THEN_CANCELED
        - ROUTED_AND_SPLIT_THEN_CANCELED
        - ROUTING_PLAN_SHORTPICKED_THEN_SPLIT_THEN_CANCELED
        - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_THEN_CANCELED
        - ROUTING_PLAN_SHORTPICKED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED
        - ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_THEN_CANCELED
        - >-
          ROUTING_PLAN_REROUTE_TIMETRIGGERED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED
        - FACILITY_MANUALLY_ASSIGNED_TO_PICKJOB_THEN_ROUTED_THEN_CANCELED
        - FACILITY_MANUALLY_ASSIGNED_TO_PROCESS_THEN_ROUTED_THEN_CANCELED
        - PROCESS_MANUAL_REROUTED_THEN_ROUTED_THEN_CANCELED
        - PROCESS_MANUAL_REROUTED_THEN_REROUTED_AND_SPLIT_THEN_CANCELED
        - CANCELED
        - NOT_ROUTABLE
        - NOT_ROUTABLE_WAS_MANUALLY_REROUTED
        - NOT_ROUTABLE_WAS_MANUALLY_ASSIGNED
        - WAITING
        - WAITING_WAS_MANUALLY_REROUTED
        - WAITING_WAS_MANUALLY_ASSIGNED
        - WAITING_AND_SPLIT
        - WAITING_THEN_ROUTED
        - WAITING_THEN_ROUTED_AND_SPLIT
        - WAITING_THEN_NOT_ROUTABLE
        - WAITING_THEN_WAITING_AND_SPLIT
        - LOCKED
        - INITIAL
      type: string
      xml:
        name: RealRoutingPlanStatus
      title: ConsolidatedRoutingPlanStatus
    ConsumerAddress:
      allOf:
        - $ref: '#/components/schemas/Address'
      properties:
        addressType:
          $ref: '#/components/schemas/AddressType'
        companyName:
          example: Speedy Boxales Ltd.
          type: string
        coordinates:
          $ref: '#/components/schemas/Coordinates'
        email:
          example: test@try.de
          format: email
          minLength: 1
          type: string
        firstName:
          example: Maxine
          type: string
        lastName:
          example: Muller
          type: string
        personalTitle:
          example: Dr.
          type: string
        salutation:
          example: Frau
          type: string
      type: object
      title: ConsumerAddress
      description: ConsumerAddress
    ConsumerAddressesForSourcingOptions:
      properties:
        addresses:
          items:
            $ref: '#/components/schemas/ConsumerAddressForSourcingOptions'
          type: array
        consumerId:
          description: The id of the consumer.
          example: e4213a07-f563-46a3-b1ba-4dfeb6abe82a
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the consumer. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        facilityRef:
          type: string
        tenantFacilityId:
          type: string
      type: object
      title: ConsumerAddressesForSourcingOptions
      description: ConsumerAddressesForSourcingOptions
    ConsumerAddressForSourcingOptions:
      additionalProperties: false
      properties:
        additionalAddressInfo:
          example: 'to care of: Mrs. Müller'
          type: string
        addressType:
          $ref: '#/components/schemas/AddressType'
        city:
          description: The city of the address.
          example: Berlin
          type: string
        companyName:
          example: Speedy Boxales Ltd.
          type: string
        coordinates:
          $ref: '#/components/schemas/Coordinates'
        country:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the address. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        email:
          example: test@try.de
          format: email
          minLength: 1
          type: string
        firstName:
          example: Maxine
          type: string
        houseNumber:
          example: 42a
          pattern: ^.+$
          type: string
        lastName:
          example: Muller
          type: string
        personalTitle:
          example: Dr.
          type: string
        phoneNumbers:
          items:
            $ref: '#/components/schemas/ConsumerAddressForSourcingOptionsPhoneNumber'
          type: array
        postalCode:
          description: The postal code of the address.
          example: 10115
          type: string
        province:
          example: NRW
          pattern: ^.+$
          type: string
        salutation:
          example: Frau
          type: string
        street:
          description: The street of the address.
          example: Invalidenstraße 116
          type: string
      required:
        - country
      title: ConsumerAddressForSourcingOptions
      description: ConsumerAddressForSourcingOptions
    ConsumerAddressForSourcingOptionsPhoneNumber:
      additionalProperties: false
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the phonenumber. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        label:
          description: >-
            Can be used to give a description for the number, like "private",
            "business number", etc.
          type: string
        type:
          enum:
            - MOBILE
            - PHONE
          type: string
        value:
          description: The number itself. We do not enforce any format (yet).
          type: string
      required:
        - value
        - type
      type: object
      title: ConsumerAddressForSourcingOptionsPhoneNumber
      description: ConsumerAddressForSourcingOptionsPhoneNumber
    ConsumerAddressModifiedLogEntry:
      properties:
        addressType:
          $ref: '#/components/schemas/AddressType'
        changedFields:
          items:
            type: string
          type: array
      type: object
      title: ConsumerAddressModifiedLogEntry
      description: ConsumerAddressModifiedLogEntry
    ConsumerAddressModifiedLogPayload:
      properties:
        changes:
          description: List of address changes
          items:
            $ref: '#/components/schemas/ConsumerAddressModifiedLogEntry'
          type: array
      type: object
      title: ConsumerAddressModifiedLogPayload
      description: ConsumerAddressModifiedLogPayload
    ContainerDimensions:
      additionalProperties: false
      properties:
        heightInCm:
          description: The height of the container (in cm)
          example: 50
          type: number
        lengthInCm:
          description: The length of the container (in cm)
          example: 100
          type: number
        weightInG:
          description: The weight of the container (in g)
          example: 1700
          type: number
        widthInCm:
          description: The width of the container (in cm)
          example: 25.5
          type: number
      type: object
      title: ContainerDimensions
      description: ContainerDimensions
    ContextLimitation:
      properties:
        type:
          description: The type of the context limitation.
          enum:
            - FACILITY
            - FACILITY_GROUP
            - ROLE
            - USER_ROLE
            - ZONE
          type: string
        values:
          description: >-
            An array defining the values the user is allowed to access — if the
            entire context object is omitted, no access restrictions apply,
            whereas an empty array explicitly grants no access (i.e., maximum
            restriction).
          items:
            type: string
          maxItems: 500
          type: array
      required:
        - type
        - values
      title: ContextLimitation
      type: object
      description: ContextLimitation
    ContextOperator:
      description: >-
        The operator used to define how the context values are evaluated or
        compared.
      enum:
        - NOT
      type: string
      title: ContextOperator
    ContextReference:
      properties:
        reference:
          type: string
        routingDecisionContext:
          $ref: '#/components/schemas/RoutingDecisionContext'
      required:
        - reference
        - routingDecisionContext
      title: ContextReference
      description: ContextReference
    Coordinates:
      description: >-
        Coordinates of the WGS84 geodetic reference system in Mercator
        projection, as used e.g. by the Google Maps API
      properties:
        lat:
          description: Latitude value
          example: 50.937531
          type: number
        lon:
          description: Longitude value
          example: 6.960279
          type: number
      required:
        - lat
        - lon
      type: object
      title: Coordinates
    CostCoefficientMeasurementUnit:
      description: The unit of measurement for the coefficient
      enum:
        - GRAM
      type: string
      title: CostCoefficientMeasurementUnit
    CountryCode:
      description: ISO 3166 ALPHA-2 of country
      example: DE
      maxLength: 2
      minLength: 2
      type: string
      title: CountryCode
    CountryLanguageMapping:
      additionalProperties:
        type: string
      example:
        DE: de_DE
        RU: ru_RU
        US: en_US
      type: object
      title: CountryLanguageMapping
      description: CountryLanguageMapping
    CurrencyCode:
      description: >-
        The currency code is a three-letter code that represents a currency in
        the ISO 4217 standard.
      enum:
        - AED
        - AFN
        - ALL
        - AMD
        - ANG
        - AOA
        - ARS
        - AUD
        - AWG
        - AZN
        - BAM
        - BBD
        - BDT
        - BGN
        - BHD
        - BIF
        - BMD
        - BND
        - BOB
        - BOV
        - BRL
        - BSD
        - BTN
        - BWP
        - BYN
        - BZD
        - CAD
        - CDF
        - CHE
        - CHF
        - CHW
        - CLF
        - CLP
        - CNY
        - COP
        - COU
        - CRC
        - CUC
        - CUP
        - CVE
        - CZK
        - DJF
        - DKK
        - DOP
        - DZD
        - EGP
        - ERN
        - ETB
        - EUR
        - FJD
        - FKP
        - GBP
        - GEL
        - GHS
        - GIP
        - GMD
        - GNF
        - GTQ
        - GYD
        - HKD
        - HNL
        - HTG
        - HUF
        - IDR
        - ILS
        - INR
        - IQD
        - IRR
        - ISK
        - JMD
        - JOD
        - JPY
        - KES
        - KGS
        - KHR
        - KMF
        - KPW
        - KRW
        - KWD
        - KYD
        - KZT
        - LAK
        - LBP
        - LKR
        - LRD
        - LSL
        - LYD
        - MAD
        - MDL
        - MGA
        - MKD
        - MMK
        - MNT
        - MOP
        - MRU
        - MUR
        - MVR
        - MWK
        - MXN
        - MXV
        - MYR
        - MZN
        - NAD
        - NGN
        - NIO
        - NOK
        - NPR
        - NZD
        - OMR
        - PAB
        - PEN
        - PGK
        - PHP
        - PKR
        - PLN
        - PYG
        - QAR
        - RON
        - RSD
        - RUB
        - RWF
        - SAR
        - SBD
        - SCR
        - SDG
        - SEK
        - SGD
        - SHP
        - SLE
        - SOS
        - SRD
        - SSP
        - STN
        - SVC
        - SYP
        - SZL
        - THB
        - TJS
        - TMT
        - TND
        - TOP
        - TRY
        - TTD
        - TWD
        - TZS
        - UAH
        - UGX
        - USD
        - USN
        - UYI
        - UYU
        - UYW
        - UZS
        - VED
        - VES
        - VND
        - VUV
        - WST
        - XAF
        - XAG
        - XAU
        - XBA
        - XBB
        - XBC
        - XBD
        - XCD
        - XDR
        - XOF
        - XPD
        - XPF
        - XPT
        - XSU
        - XTS
        - XUA
        - XXX
        - YER
        - ZAR
        - ZMW
        - ZWL
      type: string
      title: CurrencyCode
    CustomAttributableVersionedResource:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      title: CustomAttributableVersionedResource
      type: object
      description: CustomAttributableVersionedResource
    CustomAttributesResource:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
      title: CustomAttributesResource
      type: object
      description: CustomAttributesResource
    CustomClaims:
      properties:
        roles:
          description: The roles of the user
          items:
            $ref: '#/components/schemas/UserRole'
          type: array
      required:
        - roles
      title: CustomClaims
      type: object
      description: CustomClaims
    CustomPrioritizationRule:
      allOf:
        - $ref: '#/components/schemas/PrioritizationRule'
      description: >-
        You can supply a CUSTOM Prioritization rule. In order to successfully
        supply such a rule you also need to provide an evaluatable Expression in
        vmExpression. This expression needs to return an integer value that adds
        additional priority to an order.
      properties:
        vmExpression:
          example: >-
            order.customAttributes && order.customAttributes.amazon === true ?
            100 : 0
          type: string
      required:
        - vmExpression
      type: object
      xml:
        name: CustomPrioritizationRule
      title: CustomPrioritizationRule
    CustomService:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        additionalInformation:
          description: Additional information entries defined for this custom service
          items:
            $ref: '#/components/schemas/AdditionalInformation'
          maxItems: 15
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to custom service. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          nullable: true
          type: object
        description:
          description: >-
            Translated description derived from descriptionLocalized based on
            the requested locale
          example: A service that wraps gifts beautifully
          minLength: 1
          type: string
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 120
          minimum: 0
          type: integer
        id:
          description: Unique ID of this custom service
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        imageRefs:
          description: List of linked images for this custom service
          example:
            - https://my-image-host.com/images/custom-service-1.jpg
          items:
            type: string
          maxItems: 50
          type: array
        itemsRequired:
          description: >-
            Indicates whether items are required for executing a service job of
            this custom service
          enum:
            - MANDATORY
            - NONE
          example: OPTIONAL
          type: string
        itemsReturnable:
          description: >-
            Indicates if the items of the custom service are returnable after
            execution
          example: false
          type: boolean
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        name:
          description: >-
            Translated name derived from nameLocalized based on the requested
            locale
          example: Gift Wrapping
          minLength: 1
          type: string
        status:
          description: >-
            Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE
            instead
          enum:
            - ENABLED
            - DISABLED
            - INACTIVE
            - ACTIVE
          example: ACTIVE
          type: string
        tenantCustomServiceId:
          description: Tenant specific ID of the custom service
          example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
          minLength: 1
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - status
        - nameLocalized
        - itemsRequired
        - id
        - created
        - lastModified
        - version
      title: CustomService
      type: object
      description: CustomService
    CustomServiceDefinition:
      properties:
        additionalInformation:
          description: Additional information necessary to fulfil the custom service
          items:
            properties:
              additionalInformationRef:
                description: >-
                  A reference to the specific additional information of the
                  custom service
                type: string
              tenantAdditionalInformationId:
                description: The id of the tenant specific additional information
                type: string
              value:
                anyOf:
                  - type: string
                  - type: integer
                  - type: number
                  - type: boolean
                description: The value of the additional information
            required:
              - additionalInformationRef
            type: object
          maxItems: 500
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the consumer. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        customServiceRef:
          description: >-
            A reference to the custom service to be applied to the orderline
            items
          type: string
        isBundled:
          description: if true all articles below this service are intrpreted as a bundle
          type: boolean
        tenantCustomServiceId:
          description: The id of the tenant specific custom service
          type: string
      type: object
      title: CustomServiceDefinition
      description: CustomServiceDefinition
    CustomServiceForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        additionalInformation:
          description: >-
            Additional information fields to be collected when executing this
            custom service
          items:
            $ref: '#/components/schemas/AdditionalInformationForCreation'
          maxItems: 15
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to custom service. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          nullable: true
          type: object
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 120
          minimum: 0
          type: integer
        imageRefs:
          description: List of linked images for this custom service
          example:
            - https://my-image-host.com/images/custom-service-1.jpg
          items:
            type: string
          maxItems: 50
          type: array
        itemsRequired:
          description: >-
            Indicates whether items are required for executing a service job of
            this custom service
          enum:
            - MANDATORY
            - NONE
          example: OPTIONAL
          type: string
        itemsReturnable:
          description: >-
            Indicates if the items of the custom service are returnable after
            execution
          example: false
          type: boolean
        status:
          description: >-
            Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE
            instead
          enum:
            - ENABLED
            - DISABLED
            - INACTIVE
            - ACTIVE
          example: ACTIVE
          type: string
        tenantCustomServiceId:
          description: Tenant specific ID of the custom service
          example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
          minLength: 1
          type: string
      required:
        - status
        - nameLocalized
        - itemsRequired
      title: CustomServiceForCreation
      type: object
      description: CustomServiceForCreation
    CustomServiceForUpdate:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        customAttributes:
          description: >-
            Attributes that can be added to the custom service. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 100
          minimum: 0
          type: integer
        itemsRequired:
          description: >-
            Indicates whether items are required for executing a service job of
            this custom service
          enum:
            - MANDATORY
            - NONE
          example: OPTIONAL
          type: string
        itemsReturnable:
          description: >-
            Indicates if the items of the custom service are returnable after
            the custom service has been executed
          example: false
          type: boolean
        status:
          description: >-
            Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE
            instead
          enum:
            - ENABLED
            - DISABLED
            - INACTIVE
            - ACTIVE
          example: ACTIVE
          type: string
        tenantCustomServiceId:
          description: Tenant specific ID of the custom service
          example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00
          minLength: 1
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          minimum: 1
          type: integer
      required:
        - version
      title: CustomServiceForUpdate
      type: object
      description: CustomServiceForUpdate
    CustomServiceItem:
      allOf:
        - $ref: '#/components/schemas/CustomServiceItemForCreation'
      properties:
        customServiceItems:
          items:
            $ref: '#/components/schemas/CustomServiceItem'
          type: array
        id:
          type: string
      required:
        - id
        - customServiceItems
        - articleItems
        - customServiceDefinition
      type: object
      title: CustomServiceItem
      description: CustomServiceItem
    CustomServiceItemForCreation:
      additionalProperties: false
      properties:
        articleItems:
          items:
            $ref: '#/components/schemas/ArticleItem'
          maxItems: 500
          type: array
        customServiceDefinition:
          $ref: '#/components/schemas/CustomServiceDefinition'
        customServiceItems:
          items:
            $ref: '#/components/schemas/CustomServiceItemForCreation'
          maxItems: 500
          type: array
      required:
        - customServiceItems
        - articleItems
        - customServiceDefinition
      type: object
      title: CustomServiceItemForCreation
      description: CustomServiceItemForCreation
    CustomServicePatchActions:
      properties:
        actions:
          description: List of actions to apply to this custom service
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyCustomServiceAction'
          maxItems: 10
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - actions
        - version
      title: CustomServicePatchActions
      type: object
      description: CustomServicePatchActions
    CustomServiceReference:
      properties:
        articleItems:
          items:
            $ref: '#/components/schemas/ArticleItem'
          type: array
        customServiceDefinition:
          $ref: '#/components/schemas/CustomServiceDefinition'
        customServiceItems:
          items:
            $ref: '#/components/schemas/CustomServiceItem'
          type: array
        id:
          type: string
      required:
        - customServiceDefinition
        - articleItems
        - customServiceItems
        - id
      type: object
      title: CustomServiceReference
      description: CustomServiceReference
    CustomServiceReferenceForCreation:
      additionalProperties: false
      properties:
        articleItems:
          items:
            $ref: '#/components/schemas/ArticleItem'
          maxItems: 500
          type: array
        customServiceDefinition:
          $ref: '#/components/schemas/CustomServiceDefinition'
        customServiceItems:
          items:
            $ref: '#/components/schemas/CustomServiceItemForCreation'
          maxItems: 500
          type: array
      required:
        - customServiceDefinition
        - articleItems
        - customServiceItems
      type: object
      title: CustomServiceReferenceForCreation
      description: CustomServiceReferenceForCreation
    CutoffTime:
      nullable: true
      properties:
        hour:
          default: 12
          example: 16
          type: number
        minute:
          default: 0
          example: 30
          type: number
      required:
        - hour
        - minute
      type: object
      title: CutoffTime
      description: CutoffTime
    CutoffTimeConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clickAndCollect:
          $ref: '#/components/schemas/CutoffTime'
        id:
          type: string
        shipFromStore:
          $ref: '#/components/schemas/CutoffTime'
      required:
        - shipFromStore
        - clickAndCollect
      type: object
      title: CutoffTimeConfiguration
      description: CutoffTimeConfiguration
    DateEqFilter:
      properties:
        eq:
          format: date-time
          type: string
        notEq:
          format: date-time
          type: string
      title: DateEqFilter
      type: object
      description: DateEqFilter
    DateFilter:
      properties:
        after:
          description: >-
            Search using ISO‑8601 dates relative to today. Prefix with “–” for
            past dates. Results include events after the specified date.
            Example: “–P1D” for yesterday, “P1W” for next week.
          maxLength: 256
          type: string
        before:
          description: >-
            Search using ISO‑8601 dates relative to today. Prefix with “–” for
            past dates. Results include events before the specified date.
            Example: “–P1D” for yesterday, “P1W” for next week.
          maxLength: 256
          type: string
        eq:
          format: date-time
          type: string
        gt:
          format: date-time
          type: string
        gte:
          format: date-time
          type: string
        lt:
          format: date-time
          type: string
        lte:
          format: date-time
          type: string
        notEq:
          format: date-time
          type: string
      title: DateFilter
      type: object
      description: DateFilter
    DateListFilter:
      properties:
        contains:
          $ref: '#/components/schemas/DateEqFilter'
      title: DateListFilter
      type: object
      description: DateListFilter
    DecisionLog:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        facilityDecisions:
          items:
            $ref: '#/components/schemas/FacilityDecision'
          type: array
        id:
          type: string
        latestPickingStartHints:
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />In case no LPS could be calculated for this facility, the possible
            causes will be listed in this array. This property is an alpha
            property and still under development
          type: object
          x-badges:
            - color: red
              label: ALPHA
        orderSplitDecision:
          $ref: '#/components/schemas/OrderSplitDecision'
        results:
          $ref: '#/components/schemas/RoutingResults'
        routingPlanRef:
          type: string
        routingRun:
          type: number
        routingStrategyEvaluationResult:
          $ref: '#/components/schemas/RoutingStrategyEvaluationResult'
        statistics:
          $ref: '#/components/schemas/RoutingStatistics'
      required:
        - id
        - routingPlanRef
        - facilityDecisions
        - routingRun
        - statistics
        - results
        - created
        - lastModified
        - version
      type: object
      xml:
        name: DecisionLog
      title: DecisionLog
      description: DecisionLog
    DecisionLogFacilityInfo:
      properties:
        facilityRef:
          type: string
        name:
          type: string
      required:
        - name
        - facilityRef
      title: DecisionLogFacilityInfo
      description: DecisionLogFacilityInfo
    DecisionLogRef:
      properties:
        routingRun:
          type: number
        url:
          description: A reference to the finalizer decision log
          example: /api/routingplans/{routingPlanId}/decisionlogs/{routingRun}
          type: string
      required:
        - url
        - finalizeRun
      type: object
      xml:
        name: DecisionLogRef
      title: DecisionLogRef
      description: DecisionLogRef
    DecisionReasonContext:
      properties:
        type:
          enum:
            - ITEM_RETURN_LINE_ITEM_STATUS
          type: string
        values:
          items:
            enum:
              - ACCEPTED
              - REJECTED
              - WAITING_FOR_INPUT
            type: string
          maxItems: 10
          minItems: 1
          type: array
      title: DecisionReasonContext
      type: object
      description: DecisionReasonContext
    DecisionType:
      enum:
        - FENCE
        - TOOLKIT
        - TOOLKITCOMPARISON
        - RATING
      title: DecisionType
      description: DecisionType
    DefaultPickingTimesConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        pickingTimes:
          $ref: '#/components/schemas/PickingTimes'
          description: The default picking times are Mo-Sa 09:00-17:00
      required:
        - pickingTimes
      type: object
      title: DefaultPickingTimesConfiguration
      description: DefaultPickingTimesConfiguration
    DeleteRefuseReasonParameter:
      additionalProperties: false
      properties:
        handoverConfigurationVersion:
          type: number
      required:
        - handoverConfigurationVersion
      type: object
      title: DeleteRefuseReasonParameter
      description: DeleteRefuseReasonParameter
    DeliverCostCoefficient:
      additionalProperties: false
      properties:
        measurementUnit:
          $ref: '#/components/schemas/CostCoefficientMeasurementUnit'
        value:
          description: The coefficient value
          example: 1.5
          minimum: 0
          type: number
      required:
        - value
        - measurementUnit
      type: object
      title: DeliverCostCoefficient
      description: DeliverCostCoefficient
    DeliveryAddress:
      properties:
        city:
          example: Langenfeld
          pattern: ^.+$
          type: string
        companyName:
          example: OC Fulfillment GmbH
          pattern: ^.+$
          type: string
        firstName:
          example: Maxine
          pattern: ^.+$
          type: string
        houseNumber:
          example: 42a
          pattern: ^.+$
          type: string
        lastName:
          example: Muller
          pattern: ^.+$
          type: string
        personalTitle:
          example: Prof.
          pattern: ^.+$
          type: string
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      required:
        - street
        - postalCode
        - city
      type: object
      title: DeliveryAddress
      description: DeliveryAddress
    DeliveryAddressWithType:
      allOf:
        - $ref: '#/components/schemas/DeliveryAddress'
      properties:
        addressType:
          $ref: '#/components/schemas/AddressType'
      required:
        - street
        - houseNumber
        - postalCode
        - city
        - addressType
      type: object
      title: DeliveryAddressWithType
      description: DeliveryAddressWithType
    DeliveryArea:
      properties:
        country:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
      required:
        - country
        - postalCode
      type: object
      title: DeliveryArea
      description: DeliveryArea
    DeliveryCost:
      properties:
        cost:
          description: The cost of sending with a carrier
          example: 10.99
          type: number
        currency:
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          type: string
      required:
        - cost
        - currency
      title: DeliveryCost
      type: object
      description: DeliveryCost
    DeliveryEvent:
      properties:
        deliveryTarget:
          $ref: '#/components/schemas/DeliveryTarget'
        deliveryTrigger:
          enum:
            - DEFAULT
          type: string
      required:
        - deliveryTarget
        - deliveryTrigger
      title: DeliveryEvent
      description: DeliveryEvent
    DeliveryEventTargetAddress:
      properties:
        deliveryEvent:
          $ref: '#/components/schemas/DeliveryEvent'
        facilityRef:
          type: string
        targetAddress:
          $ref: '#/components/schemas/TargetAddress'
      required:
        - facilityRef
        - targetAddress
        - deliveryEvent
      type: object
      title: DeliveryEventTargetAddress
      description: DeliveryEventTargetAddress
    DeliveryNote:
      properties:
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        deliveryAddress:
          $ref: '#/components/schemas/DeliveryAddress'
          description: use this if no deliveryAddresses are passed.
        deliveryAddresses:
          description: >-
            if this field is filled, the delivery address will be taken from
            here according to this sorting: PARCEL_LOCKER > POSTAL_ADDRESS >
            INVOICE_ADDRESS. Each type is only allowed once.
          items:
            $ref: '#/components/schemas/DeliveryAddressWithType'
          type: array
        items:
          items:
            $ref: '#/components/schemas/DeliveryNoteItem'
          type: array
        orderInformation:
          $ref: '#/components/schemas/OrderInformation'
      required:
        - orderInformation
        - items
      type: object
      title: DeliveryNote
      description: DeliveryNote
    DeliveryNoteConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        articleIdLabel:
          $ref: '#/components/schemas/LocaleString'
        articleTitleLabel:
          $ref: '#/components/schemas/LocaleString'
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        description:
          $ref: '#/components/schemas/LocaleString'
        disclaimer:
          $ref: '#/components/schemas/LocaleString'
        headline:
          $ref: '#/components/schemas/LocaleString'
        id:
          example: delivery-note
          type: string
        logoUrl:
          type: string
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfiguration'
        quantityLabel:
          $ref: '#/components/schemas/LocaleString'
        substituteText:
          $ref: '#/components/schemas/LocaleString'
      required:
        - id
        - orderNumberLabel
        - orderDateLabel
        - headline
        - quantityLabel
        - articleIdLabel
        - articleTitleLabel
        - pageLabel
      type: object
      title: DeliveryNoteConfiguration
      description: DeliveryNoteConfiguration
    DeliveryNoteConfigurationForUpsert:
      properties:
        articleIdLabel:
          $ref: '#/components/schemas/LocaleString'
        articleTitleLabel:
          $ref: '#/components/schemas/LocaleString'
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        description:
          $ref: '#/components/schemas/LocaleString'
        disclaimer:
          $ref: '#/components/schemas/LocaleString'
        headline:
          $ref: '#/components/schemas/LocaleString'
        logo:
          $ref: '#/components/schemas/NamedFile'
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfigurationForUpsert'
        quantityLabel:
          $ref: '#/components/schemas/LocaleString'
        substituteText:
          $ref: '#/components/schemas/LocaleString'
        version:
          description: >-
            Version field is used in the optimistic locking process. If the
            configuration doesn't exists, this field is ignored.
          example: 1
          type: number
      required:
        - version
        - orderNumberLabel
        - orderDateLabel
        - headline
        - quantityLabel
        - articleIdLabel
        - articleTitleLabel
        - pageLabel
      type: object
      title: DeliveryNoteConfigurationForUpsert
      description: DeliveryNoteConfigurationForUpsert
    DeliveryNoteItem:
      properties:
        id:
          type: string
        quantity:
          type: string
        substitutes:
          description: Titel of the item which is substituted through this item
          type: string
        title:
          type: string
      required:
        - id
        - title
        - quantity
      type: object
      title: DeliveryNoteItem
      description: DeliveryNoteItem
    DeliveryPreferences:
      additionalProperties: false
      properties:
        collect:
          items:
            $ref: '#/components/schemas/CollectDelivery'
          maxItems: 1
          type: array
        estimatedDeliveryDate:
          description: Estimated delivery or pickup commitment.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        reservationPreferences:
          $ref: '#/components/schemas/DeliveryReservationPreferences'
        shipping:
          $ref: '#/components/schemas/DeliveryPreferencesShipping'
        sourcingOptionRefs:
          description: Id of the SourcingOptions
          items:
            description: Reference of a SourcingOptions
            example: 928f3730-bc48-4d85-b83f-3fd86b776178
            type: string
          maxItems: 500
          type: array
        supplyingFacilities:
          description: '@deprecated Use supplyingFacilities under collect'
          items:
            description: Reference of a Facility
            example: 928f3730-bc48-4d85-b83f-3fd86b776178
            type: string
          maxItems: 500
          type: array
        targetTime:
          description: At which time the result is expected.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
      type: object
      title: DeliveryPreferences
      description: DeliveryPreferences
    DeliveryPreferencesShipping:
      properties:
        carrierProductCategory:
          $ref: '#/components/schemas/CarrierProductCategory'
        desiredDeliveryTime:
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        preferredCarriers:
          items:
            $ref: '#/components/schemas/PreferredCarrier'
          maxItems: 500
          type: array
        preferredCarriersWithProduct:
          items:
            $ref: '#/components/schemas/PreferredCarrierWithProduct'
          maxItems: 500
          type: array
        preselectedFacilities:
          items:
            $ref: '#/components/schemas/PreselectedFacility'
          maxItems: 500
          type: array
        serviceLevel:
          description: >-
            DELIVERY: The parcel will reach the recipient according to the cycle
            time of the carrier, typically 1-3 days when shipping nationaly.
            SAMEDAY: The parcel will reach the recipient the same day when
            ordering.
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
      type: object
      title: DeliveryPreferencesShipping
      description: DeliveryPreferencesShipping
    DeliveryPromiseCollect:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/BasicDeliveryPromiseShipment'
      properties:
        targetTime:
          format: date-time
          type: string
      required:
        - targetTime
      type: object
      xml:
        name: DeliveryPromiseCollect
      title: DeliveryPromiseCollect
      description: DeliveryPromiseCollect
    DeliveryPromiseLineItem:
      properties:
        availabilityTimeframe:
          $ref: '#/components/schemas/AvailabilityTimeframe'
        available:
          type: number
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        quantity:
          type: number
        tenantArticleId:
          type: string
        title:
          type: string
      type: object
      title: DeliveryPromiseLineItem
      description: DeliveryPromiseLineItem
    DeliveryPromiseShipment:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/BasicDeliveryPromiseShipment'
      properties:
        carriers:
          items:
            $ref: '#/components/schemas/PromiseCarrier'
          type: array
      required:
        - carriers
      type: object
      xml:
        name: DeliveryPromiseShipment
      title: DeliveryPromiseShipment
      description: DeliveryPromiseShipment
    DeliveryReservationMode:
      enum:
        - SCHEDULED
        - ASAP
        - ALAP
      title: DeliveryReservationMode
      description: DeliveryReservationMode
    DeliveryReservationPreferences:
      properties:
        mode:
          $ref: '#/components/schemas/DeliveryReservationMode'
        reservationTime:
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
      required:
        - mode
      type: object
      title: DeliveryReservationPreferences
      description: DeliveryReservationPreferences
    DeliveryTarget:
      description: The destination for a delivery
      enum:
        - SHIP_TO_STORE
        - SHIP_TO_CUSTOMER
      type: string
      title: DeliveryTarget
    DhlTrackingLocation:
      additionalProperties: false
      description: Location information provided by DHL
      properties:
        address:
          properties:
            addressLocality:
              example: Germany
              type: string
          type: object
      title: DhlTrackingLocation
    DhlTrackingStatus:
      additionalProperties: false
      description: Native trackingStatus provided by carrier
      properties:
        description:
          description: Description of the status
          example: Parcel has been delivered
          type: string
        location:
          $ref: '#/components/schemas/DhlTrackingLocation'
        remark:
          description: Remark of the status
          example: Delivery successful
          type: string
        status:
          description: Status of the parcel as provided by carrier
          example: DELIVERED
          type: string
        statusCode:
          description: Status code of the parcel as provided by carrier
          example: delivered
          type: string
        statusDetailed:
          description: Second status description
          example: Parcel has been delivered
          type: string
        timestamp:
          description: Timestamp this status was set by the carrier
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
      required:
        - status
      title: DhlTrackingStatus
      type: object
    DhlV2CarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        alwaysDoTrackAndTrace:
          description: Whether to always perform track and trace
          type: boolean
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        sftpConfiguration:
          allOf:
            - $ref: '#/components/schemas/SftpConfiguration'
          description: SFTP configuration for track and trace
        shipperRef:
          description: Shipper reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: DhlV2CarrierConfiguration
      type: object
      description: DhlV2CarrierConfiguration
    DiagnosticCode:
      description: >-
        Indicates the specific reason a picking diagnostic was raised.


        STOCK_SHORT_PICK => The quantity picked from a partial stock location
        was below the requested quantity, while short-pick handling was enabled
        for this configuration.


        LINE_ITEM_SHORT_PICK => The quantity picked for a pick line item was
        below the requested quantity.


        STOCK_NOT_FOUND => The specified stock reference or tenant stock ID
        could not be found.


        INSUFFICIENT_STOCK => The target stock did not have enough available
        quantity to fulfill the request.
      enum:
        - STOCK_SHORT_PICK
        - LINE_ITEM_SHORT_PICK
        - STOCK_NOT_FOUND
        - INSUFFICIENT_STOCK
      type: string
      xml:
        name: DiagnosticCode
      title: DiagnosticCode
    DocumentCategory:
      enum:
        - EXTERNAL
        - DELIVERYNOTE
        - RETURNNOTE
        - SENDLABEL
        - RETURNLABEL
        - TRANSFERLABEL
        - CUSTOMS
      type: string
      title: DocumentCategory
      description: DocumentCategory
    DocumentHandling:
      properties:
        sendLabel:
          properties:
            enabled:
              default: false
              type: boolean
          required:
            - enabled
          type: object
      required:
        - sendLabel
      type: object
      title: DocumentHandling
      description: DocumentHandling
    DocumentHandlingConfiguration:
      description: >-
        The configuration allows documents that have been added to the document
        set of a pack job to be added to the process. The configuration sets the
        section names of the entities to which external documents will be added
        to. If the configuration set is empty, no external documents will be
        added to the process.
      properties:
        inheritedDocumentConfigurations:
          items:
            $ref: '#/components/schemas/InheritedDocumentConfiguration'
          type: array
      required:
        - inheritedDocumentConfigurations
      title: DocumentHandlingConfiguration
      type: object
    DocumentOperations:
      enum:
        - PRINT
        - VIEW
      type: string
      title: DocumentOperations
      description: DocumentOperations
    DocumentSet:
      properties:
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        documents:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/PrintableDocument'
          maxItems: 50
          type: array
        facilityRef:
          description: connected facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: Unique identifier for the document set
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        version:
          description: Version number for optimistic locking
          example: 1
          type: integer
      required:
        - id
        - lastModified
        - created
        - version
      title: DocumentSet
      type: object
      description: DocumentSet
    DocumentStatus:
      enum:
        - AVAILABLE
        - LOADING
        - REQUESTABLE
        - CANCELED
        - WAITING_FOR_INPUT
      type: string
      title: DocumentStatus
      description: DocumentStatus
    DocumentType:
      enum:
        - PDF
        - PNG
        - JPG
        - GIF
        - JPEG
        - XML
        - JSON
        - ZPL
      type: string
      title: DocumentType
      description: DocumentType
    DomainConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        value:
          description: User's default domain for authentication
          example: yourDomain.com
          type: string
      required:
        - value
      type: object
      title: DomainConfiguration
      description: DomainConfiguration
    DomainStatus:
      deprecated: true
      description: Deprecated. Use ModuleStatus instead.
      enum:
        - PENDING
        - CREATED
        - IN_PROGRESS
        - STUCK
        - FINISHED
        - CANCELED
        - OBSOLETE
      type: string
      title: DomainStatus
    DomainStatusHistoryItem:
      description: >-
        This item represent a process status change triggered by a specific
        domain.
      properties:
        domain:
          $ref: '#/components/schemas/DomainType'
          description: The domain of the entity that caused the status change.
        domainEntityProcessStatus:
          $ref: '#/components/schemas/DomainStatus'
          description: The assigned status
        domainRef:
          description: The id of the domain entity that caused the status change.
          type: string
        statusChangeReasonKey:
          description: >-
            This property captures the reason for the entity’s status change.
            Each domain can define its own set of reasons, represented as an
            ENUM
          type: string
        timestamp:
          description: >-
            Timestamp of the moment at which the state was notified by the
            domain.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - timestamp
        - domain
        - domainEntityProcessStatus
        - domainRef
      type: object
      title: DomainStatusHistoryItem
    DomainStatusMappingConfiguration:
      additionalProperties: false
      deprecated: true
      description: Set status mapping configuration in their respective domains.
      properties:
        pickingMappingConfiguration:
          $ref: '#/components/schemas/PickingDomainStatusConfiguration'
      type: object
      title: DomainStatusMappingConfiguration
    DomainType:
      deprecated: true
      description: Deprecated. Use ModuleType instead.
      enum:
        - ORDER
        - ROUTING_PLAN
        - PICKJOB
        - PACKJOB
        - SHIPMENT
        - HANDOVER
        - RETURN
        - SERVICE_JOB
        - ITEM_RETURN_JOB
        - PARCEL
        - RESERVATION
      type: string
      title: DomainType
    DpdChCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: DpdChCarrierConfiguration
      type: object
      description: DpdChCarrierConfiguration
    EarliestPickingStart:
      allOf:
        - $ref: '#/components/schemas/PickingStartBase'
      properties:
        earliestPickingStartDate:
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - earliestPickingStartDate
      type: object
      title: EarliestPickingStart
      description: EarliestPickingStart
    Editor:
      properties:
        userId:
          description: ID of the user who edits the pickjob
          type: string
        username:
          description: username of the user who edits the pickjob
          type: string
      required:
        - username
      type: object
      title: Editor
      description: Editor
    EffectivePermissionsResponse:
      properties:
        roles:
          description: The roles of the user
          items:
            $ref: '#/components/schemas/UserRoleWithPermissions'
          type: array
        userId:
          description: User ID of the current user
          type: string
      required:
        - userId
        - roles
      title: EffectivePermissionsResponse
      type: object
      description: EffectivePermissionsResponse
    EmailNotificationChannel:
      properties:
        enabled:
          type: boolean
        events:
          description: >-
            Supported events for triggering external notifications:
            PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE,
            ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED,
            ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED,
            ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.
          items:
            enum:
              - PICK_JOB_CREATED
              - UPCOMING_TIME_TRIGGERED_REROUTE
              - ROUTING_PLAN_NOT_ROUTABLE
              - ROUTING_PLAN_WAITING
              - ORDER_MODIFIED
              - ORDER_UNLOCKED
              - LOCKED_ORDER_CREATED
              - ORDER_FORCE_CANCELLED
              - ORDER_CANCELLED_BY_EXPIRY
              - ORDER_CANCELLED
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        id:
          type: string
        receiver:
          items:
            $ref: '#/components/schemas/EmailReceiver'
          maxItems: 200
          type: array
          uniqueItems: true
        type:
          enum:
            - EMAIL
          type: string
      required:
        - enabled
        - events
        - type
        - id
        - receiver
      title: EmailNotificationChannel
      type: object
      description: EmailNotificationChannel
    EmailNotificationChannelForCreation:
      properties:
        enabled:
          type: boolean
        events:
          description: >-
            Supported events for triggering external notifications:
            PICK_JOB_CREATED, UPCOMING_TIME_TRIGGERED_REROUTE,
            ROUTING_PLAN_NOT_ROUTABLE, ROUTING_PLAN_WAITING, ORDER_MODIFIED,
            ORDER_UNLOCKED, LOCKED_ORDER_CREATED, ORDER_FORCE_CANCELLED,
            ORDER_CANCELLED_BY_EXPIRY, ORDER_CANCELLED.
          items:
            enum:
              - PICK_JOB_CREATED
              - UPCOMING_TIME_TRIGGERED_REROUTE
              - ROUTING_PLAN_NOT_ROUTABLE
              - ROUTING_PLAN_WAITING
              - ORDER_MODIFIED
              - ORDER_UNLOCKED
              - LOCKED_ORDER_CREATED
              - ORDER_FORCE_CANCELLED
              - ORDER_CANCELLED_BY_EXPIRY
              - ORDER_CANCELLED
            type: string
          maxItems: 50
          type: array
          uniqueItems: true
        receiver:
          items:
            $ref: '#/components/schemas/EmailReceiver'
          maxItems: 200
          type: array
          uniqueItems: true
        type:
          enum:
            - EMAIL
          type: string
      required:
        - enabled
        - events
        - type
        - receiver
      title: EmailNotificationChannelForCreation
      type: object
      description: EmailNotificationChannelForCreation
    EmailReceiver:
      properties:
        email:
          example: phil.bison@fulfillmenttools.com
          format: email
          type: string
        language:
          $ref: '#/components/schemas/SupportedLocale'
      required:
        - email
        - language
      title: EmailReceiver
      type: object
      description: EmailReceiver
    Entity:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          description: The id of the entity.
          type: string
      required:
        - id
      type: object
      title: Entity
      description: Entity
    EntityLink:
      properties:
        ref:
          description: The reference ID of the linked entity
          type: string
        type:
          description: The type of the linked entity
          enum:
            - ORDER
            - FACILITY
            - ROUTING_PLAN
            - PROCESS
            - PICK_JOB
          type: string
      required:
        - ref
        - type
      title: EntityLink
      type: object
      description: EntityLink
    ErrorInner:
      properties:
        description:
          example: Missing attributes were name, address, items
          type: string
        requestVersion:
          description: The version provided within an invalid request.
          example: 41
          format: int64
          type: integer
        summary:
          example: One or more mandatory attributes were not provided.
          type: string
        version:
          example: 42
          format: int64
          type: integer
      required:
        - summary
      type: object
      title: ErrorInner
      description: ErrorInner
    EstimatedDeliveryTime:
      properties:
        maxDeliveryDays:
          description: Maximum total delivery time in days
          example: 3
          minimum: 0
          type: integer
        minDeliveryDays:
          description: Minimum total delivery time in days
          example: 1
          minimum: 0
          type: integer
      required:
        - maxDeliveryDays
        - minDeliveryDays
      type: object
      title: EstimatedDeliveryTime
      description: EstimatedDeliveryTime
    ExpectedHandoverLineItem:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/ExpectedHandoverLineItemForCreation'
      properties:
        id:
          type: string
      required:
        - id
      type: object
      title: ExpectedHandoverLineItem
      description: ExpectedHandoverLineItem
    ExpectedHandoverLineItemForCreation:
      additionalProperties: false
      properties:
        article:
          $ref: '#/components/schemas/HandoverLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        quantity:
          description: quantity of the specific item that has been provided for handover
          example: 21
          format: int64
          minimum: 1
          type: integer
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        transferId:
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - quantity
        - article
      type: object
      title: ExpectedHandoverLineItemForCreation
      description: ExpectedHandoverLineItemForCreation
    ExpectedLineItem:
      allOf:
        - $ref: '#/components/schemas/OrderLineItem'
      properties:
        facilityRef:
          type: string
        transferId:
          type: string
      required:
        - facilityRef
        - transferId
      title: ExpectedLineItem
      description: ExpectedLineItem
    ExpectedPickLineItem:
      allOf:
        - $ref: '#/components/schemas/ExpectedPickLineItemForCreation'
        - properties:
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
          required:
            - id
          type: object
      title: ExpectedPickLineItem
      description: ExpectedPickLineItem
    ExpectedPickLineItemForCreation:
      properties:
        allowedSubstitutes:
          items:
            $ref: '#/components/schemas/Substitute'
          type: array
        article:
          $ref: '#/components/schemas/PickLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the pick line. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        measurementValidation:
          $ref: '#/components/schemas/MeasurementValidation'
        partialStockLocations:
          description: >-
            Indicates where the items to pick could be found and from where the
            picking should be started.
          items:
            $ref: >-
              #/components/schemas/PickJobLineItemPartialStockLocationForCreation
          type: array
        quantity:
          description: Quantity of the specific article that has been ordered.
          example: 21
          format: int64
          minimum: 1
          type: integer
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        secondaryQuantity:
          description: Quantity of the specific article that has been ordered.
          example: 21
          format: int64
          minimum: 0
          type: integer
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        transferId:
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - transferId
        - quantity
        - article
      title: ExpectedPickLineItemForCreation
      description: ExpectedPickLineItemForCreation
    ExpiryConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        provisioningTimeOffsetInMinutes:
          minimum: 0
          type: integer
      required:
        - provisioningTimeOffsetInMinutes
      type: object
      title: ExpiryConfiguration
      description: ExpiryConfiguration
    ExpiryEntity:
      additionalProperties: false
      properties:
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        expiryTime:
          description: Time where the connected process expires, if not fulfilled
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          description: Generated identifier of this entity
          example: 611c860f-3f00-4b01-9f4c-64cdee38a30e
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        processRef:
          description: Reference to the Process of this Entity
          example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f
          type: string
        processVersion:
          description: >-
            the version of the process this expiry entity belongs to, needed for
            preventing of faulty changes via late messages
          example: 42
          format: int64
          type: integer
        provisioningTime:
          description: >-
            Planned time where this entity should be provided or handed over to
            the customer
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/ExpiryEntityStatus'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - id
        - version
        - created
        - lastModified
        - processRef
        - provisioningTime
        - expiryTime
        - status
      title: ExpiryEntity
      description: ExpiryEntity
    ExpiryEntityFilter:
      additionalProperties: false
      properties:
        endDate:
          description: end date range for expiryTime
          example: 2020-02-03T08:45:51.525Z
          format: date-time
        processRef:
          description: process of the entity you want to load
          type: string
        startDate:
          description: start date range for expiryTime
          example: 2020-02-03T08:45:51.525Z
          format: date-time
        status:
          $ref: '#/components/schemas/ExpiryEntityStatus'
      title: ExpiryEntityFilter
      description: ExpiryEntityFilter
    ExpiryEntityForCreation:
      additionalProperties: false
      properties:
        processRef:
          description: >-
            Reference to the Process for which this expiry entity will be
            created
          example: c4e5fb70-a893-4ffa-b7b0-e042cda6fb9f
          type: string
        provisioningTime:
          description: >-
            Planned time where this entity should be provided or handed over to
            the customer
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/ExpiryEntityStatus'
      required:
        - processRef
        - provisioningTime
        - status
      title: ExpiryEntityForCreation
      description: ExpiryEntityForCreation
    ExpiryEntityForUpdate:
      additionalProperties: false
      properties:
        provisioningTime:
          description: >-
            Planned time where this entity should be provided or handed over to
            the customer
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/ExpiryEntityStatus'
        version:
          description: version of the entity you want to alter
          type: integer
      required:
        - version
      title: ExpiryEntityForUpdate
      description: ExpiryEntityForUpdate
    ExpiryEntityStatus:
      enum:
        - ACTIVE
        - INACTIVE
      type: string
      title: ExpiryEntityStatus
      description: ExpiryEntityStatus
    ExpiryWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ExpiryEntity'
      required:
        - payload
      type: object
      title: ExpiryWebHookEvent
      description: ExpiryWebHookEvent
    ExportContainer:
      properties:
        created:
          description: Timestamp when the export container was created.
          format: date-time
          type: string
        customAttributes:
          description: >-
            Arbitrary key-value pairs for storing additional metadata on the
            container.
          type: object
        description:
          description: >-
            Optional description providing additional context about the
            container's purpose.
          type: string
        id:
          description: Unique identifier of the export container.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Timestamp when the export container was last modified.
          format: date-time
          type: string
        name:
          description: Human-readable name of the export container.
          type: string
        tenantExportContainerId:
          description: >-
            Caller-supplied identifier to correlate this container with an
            external system.
          example: MY_EXPORTCONTAINER_ID
          type: string
        version:
          description: >-
            Version number incremented on each update. Used for optimistic
            concurrency control.
          example: 1
          type: number
      required:
        - id
        - created
        - lastModified
        - version
        - name
      title: ExportContainer
      type: object
      description: ExportContainer
    ExportContainerForCreation:
      properties:
        customAttributes:
          description: >-
            Arbitrary key-value pairs for storing additional metadata on the
            container.
          type: object
        description:
          description: >-
            Optional description providing additional context about the
            container's purpose.
          type: string
        name:
          description: Human-readable name of the export container.
          type: string
        tenantExportContainerId:
          description: >-
            Caller-supplied identifier to correlate this container with an
            external system.
          example: MY_EXPORTCONTAINER_ID
          type: string
      required:
        - name
      title: ExportContainerForCreation
      type: object
      description: ExportContainerForCreation
    ExportContainerForUpdate:
      properties:
        customAttributes:
          description: >-
            Arbitrary key-value pairs for storing additional metadata on the
            container.
          nullable: true
          type: object
        description:
          description: >-
            Optional description providing additional context about the
            container's purpose.
          nullable: true
          type: string
        name:
          description: Human-readable name of the export container.
          type: string
        tenantExportContainerId:
          description: >-
            Caller-supplied identifier to correlate this container with an
            external system.
          example: MY_EXPORTCONTAINER_ID
          nullable: true
          type: string
        version:
          description: >-
            Current version of the export container. Must match the stored
            version to prevent concurrent update conflicts.
          example: 1
          type: number
      required:
        - version
      title: ExportContainerForUpdate
      type: object
      description: ExportContainerForUpdate
    ExportContainerPaginatedResult:
      properties:
        exportContainers:
          items:
            $ref: '#/components/schemas/ExportContainer'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - exportContainers
      title: ExportContainerPaginatedResult
      type: object
      description: ExportContainerPaginatedResult
    ExportContainerSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ExportContainerSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ExportContainerSearchPayload
      type: object
      description: ExportContainerSearchPayload
    ExportContainerSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ExportContainerSearchQuery'
          maxItems: 500
          type: array
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        description:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by description
        name:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/ExportContainerSearchQuery'
          maxItems: 500
          type: array
        tenantExportContainerId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantExportContainerId
          example: MY_EXPORTCONTAINER_ID
      title: ExportContainerSearchQuery
      type: object
      description: ExportContainerSearchQuery
    ExportOperation:
      properties:
        created:
          description: Timestamp when the export operation was created.
          format: date-time
          type: string
        dataFormat:
          description: Format of the exported data, e.g. JSONL.
          enum:
            - JSONL
          type: string
        error:
          allOf:
            - $ref: '#/components/schemas/ExportOperationError'
          description: Error details if the export operation failed.
          nullable: true
          type: object
        exportRequestRef:
          description: Reference to the export request that this operation belongs to.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        files:
          description: >-
            Files produced by this export operation, each with a download URL
            and its expiry.
          items:
            $ref: '#/components/schemas/ExportOperationFile'
          type: array
        filesDeletionDate:
          description: Timestamp when the exported files are scheduled to be deleted.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        filesExpired:
          description: >-
            Whether the exported files have already been deleted and are no
            longer accessible.
          type: boolean
        finishedAt:
          description: >-
            Timestamp when the export operation finished, either successfully or
            with an error.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        id:
          description: Unique identifier of the export operation.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Timestamp when the export operation was last modified.
          format: date-time
          type: string
        sourceType:
          description: Type of the data source that is exported, e.g. FACILITY.
          type: string
        startedAt:
          description: Timestamp when the export operation started.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        status:
          description: Current status of the export operation.
          enum:
            - RUNNING
            - COMPLETED
            - FAILED
          type: string
        trigger:
          description: How the export operation was triggered.
          enum:
            - MANUAL
          type: string
        version:
          description: >-
            Version number incremented on each update. Used for optimistic
            concurrency control.
          example: 1
          type: number
      required:
        - id
        - created
        - lastModified
        - version
        - exportRequestRef
        - sourceType
        - trigger
        - status
        - startedAt
        - filesExpired
        - dataFormat
        - files
      title: ExportOperation
      type: object
      description: ExportOperation
    ExportOperationError:
      properties:
        message:
          description: >-
            Error message describing the reason for the export operation
            failure.
          type: string
      required:
        - message
      title: ExportOperationError
      type: object
      description: ExportOperationError
    ExportOperationExportSourceTypeEnumFilter:
      properties:
        eq:
          description: Search by sourceType
          enum:
            - STOCK_SUMMARY
          type: string
        in:
          description: Search by sourceType
          items:
            enum:
              - STOCK_SUMMARY
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by sourceType
          enum:
            - STOCK_SUMMARY
          type: string
      title: ExportOperationExportSourceTypeEnumFilter
      type: object
      description: ExportOperationExportSourceTypeEnumFilter
    ExportOperationFile:
      properties:
        id:
          description: >-
            Unique identifier of the exported file, used to access it via the
            file download endpoint.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        name:
          description: Name of the exported file.
          type: string
        sizeBytes:
          description: Size of the exported file in bytes.
          type: number
        uri:
          description: Download URI of the exported file.
          example: https://example.com/resource
          type: string
      required:
        - id
        - name
        - uri
        - sizeBytes
      title: ExportOperationFile
      type: object
      description: ExportOperationFile
    ExportOperationPaginatedResult:
      properties:
        exportOperations:
          items:
            $ref: '#/components/schemas/ExportOperation'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - exportOperations
      title: ExportOperationPaginatedResult
      type: object
      description: ExportOperationPaginatedResult
    ExportOperationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ExportOperationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ExportOperationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ExportOperationSearchPayload
      type: object
      description: ExportOperationSearchPayload
    ExportOperationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ExportOperationSearchQuery'
          maxItems: 500
          type: array
        exportRequestRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by exportRequestRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        filesDeletionDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by filesDeletionDate
          example: 2026-06-17T12:00:00.000Z
        filesExpired:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by filesExpired
        finishedAt:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by finishedAt
          example: 2026-06-17T12:00:00.000Z
        or:
          items:
            $ref: '#/components/schemas/ExportOperationSearchQuery'
          maxItems: 500
          type: array
        sourceType:
          allOf:
            - $ref: '#/components/schemas/ExportOperationExportSourceTypeEnumFilter'
          description: Search by sourceType
        startedAt:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by startedAt
          example: 2026-06-17T12:00:00.000Z
        status:
          allOf:
            - $ref: '#/components/schemas/ExportOperationStatusEnumFilter'
          description: Search by status
      title: ExportOperationSearchQuery
      type: object
      description: ExportOperationSearchQuery
    ExportOperationSort:
      properties:
        filesDeletionDate:
          enum:
            - ASC
            - DESC
          type: string
        finishedAt:
          enum:
            - ASC
            - DESC
          type: string
        startedAt:
          enum:
            - ASC
            - DESC
          type: string
      title: ExportOperationSort
      type: object
      description: ExportOperationSort
    ExportOperationStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - RUNNING
            - COMPLETED
            - FAILED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - RUNNING
              - COMPLETED
              - FAILED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - RUNNING
            - COMPLETED
            - FAILED
          type: string
      title: ExportOperationStatusEnumFilter
      type: object
      description: ExportOperationStatusEnumFilter
    ExportRequest:
      properties:
        created:
          description: Timestamp when the export container was created.
          format: date-time
          type: string
        customAttributes:
          description: >-
            Arbitrary key-value pairs for storing additional metadata on the
            container.
          type: object
        dataFormat:
          description: Data format of the export request.
          enum:
            - JSONL
          type: string
        exportContainerRef:
          description: Reference to the export container.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: Unique identifier of the export container.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Timestamp when the export container was last modified.
          format: date-time
          type: string
        source:
          allOf:
            - $ref: '#/components/schemas/ExportRequestSource'
          description: Source of the export request.
        state:
          allOf:
            - $ref: '#/components/schemas/ExportRequestState'
          description: State of the export request.
        tenantExportRequestId:
          description: ID of the tenant export request associated with this container.
          example: MY_EXPORTREQUEST_ID
          type: string
        version:
          description: >-
            Version number incremented on each update. Used for optimistic
            concurrency control.
          example: 1
          type: number
      required:
        - id
        - created
        - lastModified
        - version
        - exportContainerRef
        - source
        - dataFormat
        - state
      title: ExportRequest
      type: object
      description: ExportRequest
    ExportRequestAction:
      properties:
        name:
          description: Name of the action to perform on the export request.
          enum:
            - TRIGGER_EXPORT
          type: string
      required:
        - name
      title: ExportRequestAction
      type: object
      description: ExportRequestAction
    ExportRequestActionResult:
      properties:
        name:
          description: Name of the action that was performed.
          enum:
            - TRIGGER_EXPORT
          type: string
        result:
          description: Result of the action performed on the export request.
          oneOf:
            - $ref: '#/components/schemas/ExportOperation'
      required:
        - name
        - result
      title: ExportRequestActionResult
      type: object
      description: ExportRequestActionResult
    ExportRequestExportDataFormatEnumFilter:
      properties:
        eq:
          description: Search by dataFormat
          enum:
            - JSONL
          type: string
        in:
          description: Search by dataFormat
          items:
            enum:
              - JSONL
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by dataFormat
          enum:
            - JSONL
          type: string
      title: ExportRequestExportDataFormatEnumFilter
      type: object
      description: ExportRequestExportDataFormatEnumFilter
    ExportRequestExportSourceTypeEnumFilter:
      properties:
        eq:
          description: Search by sourceType
          enum:
            - STOCK_SUMMARY
          type: string
        in:
          description: Search by sourceType
          items:
            enum:
              - STOCK_SUMMARY
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by sourceType
          enum:
            - STOCK_SUMMARY
          type: string
      title: ExportRequestExportSourceTypeEnumFilter
      type: object
      description: ExportRequestExportSourceTypeEnumFilter
    ExportRequestForCreation:
      properties:
        customAttributes:
          description: >-
            Arbitrary key-value pairs for storing additional metadata on the
            container.
          type: object
        dataFormat:
          description: Data format of the export request.
          enum:
            - JSONL
          type: string
        source:
          allOf:
            - $ref: '#/components/schemas/ExportRequestSource'
          description: Source of the export request.
        tenantExportRequestId:
          description: ID of the tenant export request associated with this container.
          example: MY_EXPORTREQUEST_ID
          type: string
      required:
        - source
        - dataFormat
      title: ExportRequestForCreation
      type: object
      description: ExportRequestForCreation
    ExportRequestForUpdate:
      properties:
        customAttributes:
          description: >-
            Arbitrary key-value pairs for storing additional metadata on the
            request.
          nullable: true
          type: object
        source:
          allOf:
            - $ref: '#/components/schemas/ExportRequestSource'
          description: Source of the export request.
        tenantExportRequestId:
          description: ID of the tenant export request associated with this request.
          example: MY_EXPORTREQUEST_ID
          nullable: true
          type: string
        version:
          description: >-
            Current version of the export request. Must match the stored version
            to prevent concurrent update conflicts.
          example: 1
          type: number
      required:
        - version
      title: ExportRequestForUpdate
      type: object
      description: ExportRequestForUpdate
    ExportRequestPaginatedResult:
      properties:
        exportRequests:
          items:
            $ref: '#/components/schemas/ExportRequest'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - exportRequests
      title: ExportRequestPaginatedResult
      type: object
      description: ExportRequestPaginatedResult
    ExportRequestSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ExportRequestSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ExportRequestSearchPayload
      type: object
      description: ExportRequestSearchPayload
    ExportRequestSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ExportRequestSearchQuery'
          maxItems: 500
          type: array
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        dataFormat:
          allOf:
            - $ref: '#/components/schemas/ExportRequestExportDataFormatEnumFilter'
          description: Search by dataFormat
          example: 2026-06-17T12:00:00.000Z
        exportContainerRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by exportContainerRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/ExportRequestSearchQuery'
          maxItems: 500
          type: array
        sourceType:
          allOf:
            - $ref: '#/components/schemas/ExportRequestExportSourceTypeEnumFilter'
          description: Search by sourceType
        tenantExportRequestId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantExportRequestId
          example: MY_EXPORTREQUEST_ID
      title: ExportRequestSearchQuery
      type: object
      description: ExportRequestSearchQuery
    ExportRequestSource:
      properties:
        type:
          description: Type of the export request source.
          enum:
            - STOCK_SUMMARY
          type: string
      required:
        - type
      title: ExportRequestSource
      type: object
      description: ExportRequestSource
    ExportRequestState:
      properties:
        lastOperationFinishedAt:
          description: Timestamp when the last operation on the export request finished.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        lastOperationId:
          description: ID of the last operation performed on the export request.
          type: string
        lastOperationStatus:
          description: Status of the last operation performed on the export request.
          enum:
            - RUNNING
            - COMPLETED
            - FAILED
          type: string
        status:
          description: Status of the export request.
          enum:
            - IDLE
            - RUNNING
          type: string
      required:
        - status
      title: ExportRequestState
      type: object
      description: ExportRequestState
    ExpressionGuardCondition:
      properties:
        entity:
          description: Entity the expression applies to
          enum:
            - ORDER
            - INCOMING_EVENT
          type: string
        expression:
          description: JSONPath expression evaluated to decide the guard.
          type: string
        kind:
          description: 'Discriminator: expression-based guard.'
          enum:
            - EXPRESSION
          type: string
      required:
        - kind
        - expression
        - entity
      title: ExpressionGuardCondition
      type: object
      description: ExpressionGuardCondition
    ExternalAction:
      allOf:
        - $ref: '#/components/schemas/ExternalActionForReplacement'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          description: >-
            The id of this external action. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        name:
          description: The name of this external action.
          type: string
        processRef:
          description: Id of the global process related to this entity.
          type: string
      required:
        - id
        - name
        - processRef
      type: object
      xml:
        name: ExternalAction
      title: ExternalAction
      description: ExternalAction
    ExternalActionExecutedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ExternalActionExecutedWebHookEventPayload'
      required:
        - payload
      type: object
      title: ExternalActionExecutedWebHookEvent
      description: ExternalActionExecutedWebHookEvent
    ExternalActionExecutedWebHookEventPayload:
      properties:
        actionPayload:
          oneOf:
            - $ref: '#/components/schemas/ExternalLinkActionLogPayload'
            - $ref: '#/components/schemas/ExternalFormActionLogPayload'
          type: object
        editor:
          $ref: '#/components/schemas/Editor'
        externalActionRef:
          type: string
        logId:
          type: string
        type:
          $ref: '#/components/schemas/ExternalActionType'
      required:
        - logId
        - externalActionRef
        - type
        - editor
        - actionPayload
      type: object
      title: ExternalActionExecutedWebHookEventPayload
      description: ExternalActionExecutedWebHookEventPayload
    ExternalActionForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: The name of this external action localized
          example: '{ en_US: ''SomeName'' }'
        action:
          oneOf:
            - $ref: '#/components/schemas/ExternalFormActionDefinition'
            - $ref: '#/components/schemas/ExternalLinkActionDefinition'
            - $ref: '#/components/schemas/ExternalCommentActionDefinition'
          discriminator:
            propertyName: type
            mapping:
              BLANK_LINK: '#/components/schemas/ExternalLinkActionDefinition'
              COMMENT: '#/components/schemas/ExternalCommentActionDefinition'
              FORM: '#/components/schemas/ExternalFormActionDefinition'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        groups:
          items:
            description: User-defined text strings for grouping external actions
            type: string
          type: array
        processRef:
          description: Id of the global process related to this entity.
          type: string
      required:
        - processRef
        - nameLocalized
        - groups
        - action
      type: object
      xml:
        name: ExternalActionForCreation
      title: ExternalActionForCreation
      description: ExternalActionForCreation
    ExternalActionForReplacement:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: The name of this external action localized
          example: '{ en_US: ''SomeName'' }'
        action:
          oneOf:
            - $ref: '#/components/schemas/ExternalFormActionDefinition'
            - $ref: '#/components/schemas/ExternalLinkActionDefinition'
            - $ref: '#/components/schemas/ExternalCommentActionDefinition'
          discriminator:
            propertyName: type
            mapping:
              BLANK_LINK: '#/components/schemas/ExternalLinkActionDefinition'
              COMMENT: '#/components/schemas/ExternalCommentActionDefinition'
              FORM: '#/components/schemas/ExternalFormActionDefinition'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        groups:
          items:
            description: User-defined text strings for grouping external actions
            type: string
          type: array
        version:
          example: 42
          format: int64
          type: integer
      required:
        - version
        - nameLocalized
        - groups
        - action
      type: object
      xml:
        name: ExternalActionForReplacement
      title: ExternalActionForReplacement
      description: ExternalActionForReplacement
    ExternalActionHistoryLogPayload:
      properties:
        groups:
          items:
            type: string
          type: array
      required:
        - groups
      type: object
      title: ExternalActionHistoryLogPayload
      description: ExternalActionHistoryLogPayload
    ExternalActionLog:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/ExternalActionLogForCreation'
      properties:
        created:
          description: The date this action has been executed
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        editor:
          $ref: '#/components/schemas/Editor'
        externalActionRef:
          description: Id of the refered external action.
          type: string
        id:
          type: string
      required:
        - id
        - externalActionRef
        - editor
        - created
      type: object
      xml:
        name: ExternalActionLog
      title: ExternalActionLog
      description: ExternalActionLog
    ExternalActionLogForCreation:
      properties:
        actionPayload:
          oneOf:
            - $ref: '#/components/schemas/ExternalLinkActionLogPayload'
            - $ref: '#/components/schemas/ExternalFormActionLogPayload'
            - $ref: '#/components/schemas/ExternalCommentActionLogPayload'
        requiresAnonymization:
          type: boolean
      required:
        - requiresAnonymization
        - actionPayload
      type: object
      xml:
        name: ExternalActionLogForCreation
      title: ExternalActionLogForCreation
      description: ExternalActionLogForCreation
    ExternalActionLogs:
      additionalProperties: false
      properties:
        externalActionLogs:
          items:
            $ref: '#/components/schemas/ExternalActionLog'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      required:
        - externalActionLogs
        - total
      type: object
      title: ExternalActionLogs
      description: ExternalActionLogs
    ExternalActions:
      additionalProperties: false
      properties:
        externalActions:
          items:
            $ref: '#/components/schemas/ExternalAction'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      required:
        - externalActions
        - total
      type: object
      title: ExternalActions
      description: ExternalActions
    ExternalActionType:
      description: The type of an external action
      enum:
        - BLANK_LINK
        - FORM
        - COMMENT
      type: string
      title: ExternalActionType
    ExternalCommentActionDefinition:
      additionalProperties: false
      description: >-
        This action provides a possibility to set comments. It also enables a
        possibility to save action results for other actions.
      properties:
        isInternal:
          default: false
          description: >-
            Whether or not this action is meant to be internally to the
            fulfillmenttools platform. If true, an additional entry in the
            actions dropdown will be added.
          type: boolean
        type:
          $ref: '#/components/schemas/ExternalActionType'
      required:
        - type
      title: ExternalCommentActionDefinition
      type: object
      xml:
        name: ExternalCommentActionDefinition
    ExternalCommentActionLogPayload:
      additionalProperties: false
      description: >-
        This action payload provides a possibility to set comments. It also
        enables a possibility to save action results for other actions.
      properties:
        comment:
          description: The actual comment.
          minLength: 1
          type: string
        externalActionRef:
          description: >-
            An existing external action id you want to link with. The action
            have to be in the same process.
          minLength: 1
          type: string
      required:
        - comment
      title: ExternalCommentActionLogPayload
      type: object
      xml:
        name: ExternalCommentActionLogPayload
    ExternalDocument:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        name:
          type: string
        path:
          type: string
        priority:
          minimum: 0
          type: number
        section:
          $ref: '#/components/schemas/Section'
        type:
          $ref: '#/components/schemas/DocumentType'
      required:
        - type
        - section
        - id
      type: object
      title: ExternalDocument
      description: ExternalDocument
    ExternalDocumentContentForUpdate:
      properties:
        documentSetVersion:
          description: Version of documentSet to which this document belongs.
          example: 2
          type: number
        file:
          $ref: '#/components/schemas/NamedFile'
      required:
        - documentSetVersion
        - file
      title: ExternalDocumentContentForUpdate
      type: object
      description: ExternalDocumentContentForUpdate
    ExternalDocumentForCreation:
      additionalProperties: false
      properties:
        file:
          $ref: '#/components/schemas/NamedFile'
        priority:
          minimum: 0
          type: number
        section:
          $ref: '#/components/schemas/Section'
        type:
          $ref: '#/components/schemas/DocumentType'
      required:
        - type
        - section
      type: object
      title: ExternalDocumentForCreation
      description: ExternalDocumentForCreation
    ExternalDocumentForUpdate:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        file:
          $ref: '#/components/schemas/NamedFile'
      required:
        - file
      type: object
      title: ExternalDocumentForUpdate
      description: ExternalDocumentForUpdate
    ExternalDocumentInSectionForCreation:
      additionalProperties: false
      properties:
        file:
          $ref: '#/components/schemas/NamedFile'
        priority:
          minimum: 0
          type: number
        type:
          $ref: '#/components/schemas/DocumentType'
      required:
        - type
      type: object
      title: ExternalDocumentInSectionForCreation
      description: ExternalDocumentInSectionForCreation
    ExternalFormActionButton:
      additionalProperties: false
      properties:
        labelLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: The name of this external action localized
          example: '{ en_US: ''SomeName'' }'
        label:
          type: string
      required:
        - labelLocalized
      type: object
      xml:
        name: ExternalFormActionElement
      title: ExternalFormActionButton
      description: ExternalFormActionButton
    ExternalFormActionDefinition:
      additionalProperties: false
      description: External Form Action.
      properties:
        cancel:
          $ref: '#/components/schemas/ExternalFormActionButton'
        elements:
          items:
            anyOf:
              - $ref: '#/components/schemas/ExternalFormActionElement'
              - $ref: '#/components/schemas/ExternalFormActionInputElement'
            discriminator:
              propertyName: elementType
              mapping:
                HEADLINE: '#/components/schemas/ExternalFormActionElement'
                SUBHEADLINE: '#/components/schemas/ExternalFormActionElement'
                TEXT: '#/components/schemas/ExternalFormActionElement'
                TEXT_INPUT: '#/components/schemas/ExternalFormActionInputElement'
          minItems: 1
          type: array
        success:
          $ref: '#/components/schemas/ExternalFormActionButton'
        type:
          $ref: '#/components/schemas/ExternalActionType'
      required:
        - elements
        - type
        - cancel
      title: ExternalFormActionDefinition
      type: object
      xml:
        name: ExternalFormActionDefinition
    ExternalFormActionElement:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: The name of this external action localized
          example: '{ en_US: ''SomeName'' }'
        elementType:
          $ref: '#/components/schemas/ExternalFormActionElementType'
        style:
          description: it is only allowed to set a style for elementType TEXT
          enum:
            - BODY
            - INFO
            - WARN
            - ERROR
          type: string
        title:
          type: string
      required:
        - elementType
        - titleLocalized
      type: object
      xml:
        name: ExternalFormActionElement
      title: ExternalFormActionElement
      description: ExternalFormActionElement
    ExternalFormActionElementType:
      enum:
        - TEXT_INPUT
        - HEADLINE
        - SUBHEADLINE
        - TEXT
      type: string
      title: ExternalFormActionElementType
      description: ExternalFormActionElementType
    ExternalFormActionInputElement:
      additionalProperties: false
      description: External Form Input Action.
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: The name of this external action localized
          example: '{ en_US: ''SomeName'' }'
        elementId:
          type: string
        elementType:
          $ref: '#/components/schemas/ExternalFormActionElementType'
        isMandatory:
          type: boolean
        style:
          enum:
            - BODY
            - INFO
            - WARN
            - ERROR
          type: string
        title:
          type: string
        validation:
          anyOf:
            - $ref: '#/components/schemas/StringValidation'
            - $ref: '#/components/schemas/IntegerValidation'
            - $ref: '#/components/schemas/FloatValidation'
          discriminator:
            propertyName: validationType
            mapping:
              FLOAT: '#/components/schemas/FloatValidation'
              INTEGER: '#/components/schemas/IntegerValidation'
              STRING: '#/components/schemas/StringValidation'
      required:
        - elementId
        - titleLocalized
        - elementType
      title: ExternalFormActionInputElement
      type: object
      xml:
        name: ExternalFormActionInputElement
    ExternalFormActionLogPayload:
      description: External Form Action Log Payload.
      properties:
        elements:
          items:
            $ref: '#/components/schemas/ExternalFormActionLogPayloadElement'
          minItems: 1
          type: array
      required:
        - elements
      title: ExternalFormActionLogPayload
      type: object
      xml:
        name: ExternalFormActionLogPayload
    ExternalFormActionLogPayloadElement:
      properties:
        elementId:
          type: string
        value:
          type: string
      required:
        - elementId
        - value
      type: object
      xml:
        name: ExternalFormActionLogPayloadElement
      title: ExternalFormActionLogPayloadElement
      description: ExternalFormActionLogPayloadElement
    ExternalLinkActionDefinition:
      additionalProperties: false
      description: External Link Action.
      properties:
        linkUrl:
          type: string
        type:
          $ref: '#/components/schemas/ExternalActionType'
      required:
        - linkUrl
        - type
      title: ExternalLinkActionDefinition
      type: object
      xml:
        name: ExternalLinkActionDefinition
    ExternalLinkActionLogPayload:
      description: External Link Action Log Payload.
      properties:
        linkOpenedAt:
          description: The date when this link was opened.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - linkOpenedAt
      title: ExternalLinkActionLogPayload
      type: object
      xml:
        name: ExternalLinkActionLogPayload
    ExternalPrintableDocumentForCreation:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        file:
          $ref: '#/components/schemas/NamedFile'
        operations:
          items:
            enum:
              - PRINT
              - VIEW
            type: string
          maxItems: 10
          minItems: 1
          type: array
        priority:
          type: number
        status:
          enum:
            - AVAILABLE
            - LOADING
            - REQUESTABLE
            - CANCELED
            - WAITING_FOR_INPUT
          type: string
        type:
          enum:
            - PDF
            - PNG
            - JPG
            - GIF
            - JPEG
            - XML
            - JSON
            - ZPL
          type: string
      required:
        - type
      title: ExternalPrintableDocumentForCreation
      type: object
      description: ExternalPrintableDocumentForCreation
    ExternalStockChangeReason:
      properties:
        reasonLocalized:
          additionalProperties:
            maxLength: 255
            type: string
          description: >-
            Localizations, i.e. names which are to be displayed. Each localized
            string must not exceed 255 characters
          example:
            de_DE: FUND
            en_US: FOUND
          type: object
        active:
          description: Whether the reason is active
          example: true
          type: boolean
        created:
          description: Date of creation
          format: date-time
          type: string
        customAttributes:
          description: The custom attributes of this external stock change reason
          type: object
        id:
          description: Id of the external stock change reason
          example: 5aa18b4d-45de-4e9e-92db-936288040272
          type: string
        lastModified:
          description: Date of last modification
          format: date-time
          type: string
        tenantReasonId:
          description: Identifier of the stock change reason
          example: F12
          type: string
        version:
          description: Version of the external stock change reason
          example: 1
          type: number
      required:
        - active
        - reasonLocalized
        - id
        - version
      title: ExternalStockChangeReason
      type: object
      description: ExternalStockChangeReason
    ExternalStockChangeReasonForCreation:
      properties:
        reasonLocalized:
          additionalProperties:
            maxLength: 255
            type: string
          description: >-
            Localizations, i.e. names which are to be displayed. Each localized
            string must not exceed 255 characters
          example:
            de_DE: FUND
            en_US: FOUND
          type: object
        active:
          description: Whether the reason is active
          example: true
          type: boolean
        customAttributes:
          description: The custom attributes of this external stock change reason
          type: object
        tenantReasonId:
          description: Identifier of the stock change reason
          example: F12
          type: string
      required:
        - active
        - reasonLocalized
      title: ExternalStockChangeReasonForCreation
      type: object
      description: ExternalStockChangeReasonForCreation
    ExternalStockChangeReasonForUpdate:
      properties:
        reasonLocalized:
          additionalProperties:
            maxLength: 255
            type: string
          description: >-
            Localizations, i.e. names which are to be displayed. Each localized
            string must not exceed 255 characters
          example:
            de_DE: FUND
            en_US: FOUND
          type: object
        active:
          description: Whether the reason is active
          example: true
          type: boolean
        customAttributes:
          description: The custom attributes of this external stock change reason
          type: object
        id:
          description: Id of the external stock change reason
          example: 5aa18b4d-45de-4e9e-92db-936288040272
          type: string
        version:
          description: Version of the external stock change reason
          example: 1
          type: number
      required:
        - version
      title: ExternalStockChangeReasonForUpdate
      type: object
      description: ExternalStockChangeReasonForUpdate
    ExternalStockChangeReasonInput:
      properties:
        reasonLocalized:
          description: >-
            List of localized reason strings. If provided, no preconfiguration
            is necessary. Cannot be provided in combination with id or existing
            tenantReasonId.
          type: object
        id:
          description: ID of reason. Use to enrich with preconfigured reason
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantReasonId:
          description: >-
            tenantReasonId of reason. If no reasonLocalized provided, a
            preconfigured reason with the tenantReasonId must be present
          example: MY_REASON_ID
          type: string
      title: ExternalStockChangeReasonInput
      type: object
      description: ExternalStockChangeReasonInput
    ExternalStockChangeReasonOutput:
      properties:
        reasonLocalized:
          description: Localized reason strings
          type: object
        tenantReasonId:
          description: tenantReasonId of reason
          example: MY_REASON_ID
          type: string
      required:
        - reasonLocalized
      title: ExternalStockChangeReasonOutput
      type: object
      description: ExternalStockChangeReasonOutput
    Facility:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/FacilityForCreation'
      properties:
        id:
          description: >-
            The id of this facility. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        operativeCosts:
          items:
            $ref: '#/components/schemas/FacilityOperativeCost'
          maxItems: 1
          type: array
      required:
        - id
        - type
        - status
      type: object
      xml:
        name: Facility
      title: Facility
      description: Facility
    FacilityActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/RemoveFacilityCoordinatesActionParameter'
        - $ref: '#/components/schemas/UpdateFacilityCoordinatesActionParameter'
      title: FacilityActionsParameter
      description: FacilityActionsParameter
    FacilityAddress:
      allOf:
        - $ref: '#/components/schemas/FacilityAddressForCreation'
        - properties:
            resolvedTimeZone:
              $ref: '#/components/schemas/TimeZone'
          type: object
      type: object
      xml:
        name: FacilityAddress
      title: FacilityAddress
      description: FacilityAddress
    FacilityAddressEmailAddressesFilter:
      properties:
        recipient:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by recipient
        value:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by value
      title: FacilityAddressEmailAddressesFilter
      type: object
      description: FacilityAddressEmailAddressesFilter
    FacilityAddressEmailAddressesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/FacilityAddressEmailAddressesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: FacilityAddressEmailAddressesListFilter
      type: object
      description: FacilityAddressEmailAddressesListFilter
    FacilityAddressFilter:
      properties:
        city:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by city
          example: Yellowstone
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by companyName
        country:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by country
          example: US
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        emailAddresses:
          allOf:
            - $ref: '#/components/schemas/FacilityAddressEmailAddressesListFilter'
          description: Nested list search by emailAddresses
          example: phil.bison@fulfillmenttools.com
        houseNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by houseNumber
          example: 42
        postalCode:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by postalCode
          example: '42420'
        province:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by province
        street:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by street
      title: FacilityAddressFilter
      type: object
      description: FacilityAddressFilter
    FacilityAddressForCreation:
      allOf:
        - $ref: '#/components/schemas/Address'
        - properties:
            companyName:
              example: Speedy Boxales Ltd.
              type: string
            emailAddresses:
              items:
                properties:
                  recipient:
                    description: >-
                      Human readable information who is the recipient for emails
                      sent to this address.
                    example: >-
                      'Mailinglist reaching all the employees', 'Marc Fulton,
                      Manager', etc.
                    type: string
                  value:
                    type: string
                required:
                  - value
                type: object
              maxItems: 10
              type: array
            resolvedCoordinates:
              $ref: '#/components/schemas/Coordinates'
            resolvedTimeZone:
              allOf:
                - $ref: '#/components/schemas/TimeZoneForCreation'
              description: >-
                User-specified time zone in identifier format (e.g.,
                "America/Los_Angeles"). Used to determine local time. Relevant
                only if the country spans multiple time zones; otherwise, the
                time zone is automatically determined from the country or via
                Google if unspecified.
              example: America/Los_Angeles
          required:
            - companyName
          type: object
      type: object
      xml:
        name: FacilityAddressForCreation
      title: FacilityAddressForCreation
      description: FacilityAddressForCreation
    FacilityAddressSort:
      properties:
        city:
          enum:
            - ASC
            - DESC
          type: string
        country:
          enum:
            - ASC
            - DESC
          type: string
        postalCode:
          enum:
            - ASC
            - DESC
          type: string
      title: FacilityAddressSort
      type: object
      description: FacilityAddressSort
    FacilityCarrierConnection:
      properties:
        carrierRef:
          description: Reference to the carrier
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        configuration:
          additionalProperties: true
          description: Carrier-specific configuration
          type: object
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        credentials:
          additionalProperties: true
          description: Carrier-specific credentials
          type: object
        cutoffTime:
          $ref: '#/components/schemas/CutoffTime'
          description: Cutoff time configuration
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
          description: Carrier cutoff times configuration
        deliveryAreas:
          description: Delivery areas supported by this connection
          items:
            $ref: '#/components/schemas/DeliveryArea'
          type: array
        deliveryType:
          description: Type of delivery service
          enum:
            - SAMEDAY
            - DELIVERY
          type: string
        facilityRef:
          description: Reference to the facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: Unique identifier for the facility carrier connection
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        key:
          description: Configuration key for the carrier connection
          type: string
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        name:
          description: Human-readable name for the connection
          type: string
        parcelLabelClassifications:
          description: Parcel label classifications
          items:
            $ref: '#/components/schemas/ParcelLabelClassification'
          type: array
        status:
          description: Status of the carrier connection
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        validDeliveryTargets:
          description: Valid delivery targets for this connection
          items:
            $ref: '#/components/schemas/DeliveryTarget'
          type: array
        version:
          description: Version number for optimistic locking
          example: 1
          type: number
        tags:
          description: Tags associated with the connection
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - id
        - version
        - created
        - lastModified
        - facilityRef
        - carrierRef
        - key
        - status
      title: FacilityCarrierConnection
      type: object
      description: FacilityCarrierConnection
    FacilityCarrierConnectionForCreation:
      properties:
        configuration:
          additionalProperties: true
          description: Carrier-specific configuration
          type: object
        credentials:
          additionalProperties: true
          description: Carrier-specific credentials
          type: object
        cutoffTime:
          $ref: '#/components/schemas/CutoffTime'
          description: Cutoff time configuration
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
          description: Carrier cutoff times configuration
        deliveryAreas:
          description: Delivery areas supported by this connection
          items:
            $ref: '#/components/schemas/DeliveryArea'
          type: array
        name:
          description: Human-readable name for the connection
          type: string
        parcelLabelClassifications:
          description: Parcel label classifications for creation
          items:
            $ref: '#/components/schemas/ParcelLabelClassificationForCreation'
          type: array
        status:
          description: Status of the carrier connection
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        validDeliveryTargets:
          description: Valid delivery targets for this connection
          items:
            $ref: '#/components/schemas/DeliveryTarget'
          type: array
        tags:
          description: Tags associated with the connection
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      title: FacilityCarrierConnectionForCreation
      type: object
      description: FacilityCarrierConnectionForCreation
    FacilityCarrierConnectionForModification:
      properties:
        configuration:
          additionalProperties: true
          description: Carrier-specific configuration
          type: object
        credentials:
          additionalProperties: true
          description: Carrier-specific credentials
          type: object
        cutoffTime:
          $ref: '#/components/schemas/CutoffTime'
          description: Cutoff time configuration
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
          description: Carrier cutoff times configuration
        deliveryAreas:
          description: Delivery areas supported by this connection
          items:
            $ref: '#/components/schemas/DeliveryArea'
          type: array
        name:
          description: Human-readable name for the connection
          type: string
        parcelLabelClassifications:
          description: Parcel label classifications for creation
          items:
            $ref: '#/components/schemas/ParcelLabelClassificationForCreation'
          type: array
        status:
          description: Status of the carrier connection
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        validDeliveryTargets:
          description: Valid delivery targets for this connection
          items:
            $ref: '#/components/schemas/DeliveryTarget'
          type: array
        version:
          description: Version number for optimistic locking
          example: 1
          type: number
        tags:
          description: Tags associated with the connection
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - version
      title: FacilityCarrierConnectionForModification
      type: object
      description: FacilityCarrierConnectionForModification
    FacilityContact:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the contact. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        firstName:
          type: string
        lastName:
          type: string
        roleDescription:
          example: Manager, Supervisor, Teamleader, etc.
          type: string
      required:
        - firstName
        - lastName
      type: object
      xml:
        name: FacilityContact
      title: FacilityContact
      description: FacilityContact
    FacilityContactFilter:
      properties:
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by lastName
      title: FacilityContactFilter
      type: object
      description: FacilityContactFilter
    FacilityCreatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ManagedFacility'
      required:
        - payload
      type: object
      title: FacilityCreatedWebHookEvent
      description: FacilityCreatedWebHookEvent
    FacilityCustomServiceConnection:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customServiceRef:
          description: ID of the custom service this connection belongs to
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 100
          minimum: 0
          type: integer
        facilityRef:
          description: ID of the facility this connection belongs to
          example: ba095e30-879f-11ee-b9d1-0242ac120002
          minLength: 1
          type: string
        id:
          description: Unique ID of this facility to custom service connection
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        status:
          description: Status of the connection between facility and custom service
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - status
        - id
        - version
        - created
        - lastModified
        - facilityRef
        - customServiceRef
      title: FacilityCustomServiceConnection
      type: object
      description: FacilityCustomServiceConnection
    FacilityCustomServiceConnectionForCreation:
      properties:
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 100
          minimum: 0
          type: integer
        status:
          description: Status of the connection between facility and custom service
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
          type: string
      required:
        - status
      title: FacilityCustomServiceConnectionForCreation
      type: object
      description: FacilityCustomServiceConnectionForCreation
    FacilityCustomServiceConnectionForUpdate:
      properties:
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 100
          minimum: 0
          type: integer
        status:
          description: New status to set for this facility to custom service connection
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
          type: string
        version:
          description: Version of the documentSet you want to update a document of
          example: 42
          format: int64
          type: integer
      required:
        - version
      title: FacilityCustomServiceConnectionForUpdate
      type: object
      description: FacilityCustomServiceConnectionForUpdate
    FacilityDecision:
      properties:
        availabilities:
          items:
            $ref: '#/components/schemas/AvailabilityDuringRouting'
          type: array
        facility:
          $ref: '#/components/schemas/DecisionLogFacilityInfo'
        isBestAvailable:
          type: boolean
        isBestRated:
          type: boolean
        isBestReassignmentCandidate:
          type: boolean
        latestPickingStartInformation:
          $ref: '#/components/schemas/LatestPickingStartForDecisionLog'
        orderFences:
          items:
            $ref: '#/components/schemas/OrderFenceDecision'
          type: array
        orderLineItemFences:
          items:
            $ref: '#/components/schemas/OrderLineItemFenceDecisions'
          type: array
        orderRatings:
          items:
            $ref: '#/components/schemas/OrderRatingDecision'
          type: array
        rank:
          type: number
        totalPenalty:
          type: number
      required:
        - facility
        - orderFences
        - orderLineItemFences
        - orderRatings
        - orderLineItemRatings
        - availabilities
      title: FacilityDecision
      description: FacilityDecision
    FacilityDeletedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          description: The id of the deleted facility
          type: string
      required:
        - payload
      type: object
      title: FacilityDeletedWebHookEvent
      description: FacilityDeletedWebHookEvent
    FacilityDiscount:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/FacilityDiscountForCreation'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        discount:
          oneOf:
            - $ref: '#/components/schemas/FacilityDiscountRelative'
            - $ref: '#/components/schemas/FacilityDiscountAbsolute'
        facilityRef:
          description: >-
            The id of the facility the discount belongs to. It is generated
            during creation automatically and suits as the primary identifier of
            the described entity.
          example: 5d35d4b8-8a07-40c5-8486-eae2de902597
          type: string
        id:
          description: >-
            The id of the supplier discount. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: 5d35d4b8-8a07-40c5-8486-eae2de902597
          type: string
      required:
        - facilityRef
        - discount
        - priority
        - type
        - id
      title: FacilityDiscount
      description: FacilityDiscount
    FacilityDiscountAbsolute:
      additionalProperties: false
      properties:
        type:
          enum:
            - ABSOLUTE
          type: string
        values:
          items:
            $ref: '#/components/schemas/FacilityDiscountAbsoluteElement'
          minItems: 1
          type: array
      required:
        - type
        - values
      type: object
      title: FacilityDiscountAbsolute
      description: FacilityDiscountAbsolute
    FacilityDiscountAbsoluteElement:
      additionalProperties: false
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the price as an ISO 4217 code.
          example: EUR
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          minimum: 0
          type: integer
        value:
          description: >-
            Total value that should be shipped. Value is configured in the
            smallest subunit, e.g. cents.
          example: 5
          minimum: 1
          type: integer
      required:
        - value
        - currency
        - decimalPlaces
      type: object
      title: FacilityDiscountAbsoluteElement
      description: FacilityDiscountAbsoluteElement
    FacilityDiscountAbsoluteForCreation:
      additionalProperties: false
      properties:
        type:
          enum:
            - ABSOLUTE
          type: string
        values:
          items:
            $ref: '#/components/schemas/FacilityDiscountAbsoluteElement'
          minItems: 1
          type: array
      required:
        - type
        - values
      type: object
      title: FacilityDiscountAbsoluteForCreation
      description: FacilityDiscountAbsoluteForCreation
    FacilityDiscountContext:
      additionalProperties: false
      description: >-
        The context of the discount. This is used to determine the conditions 
        under which the discount can be applied.
      properties:
        operator:
          $ref: '#/components/schemas/ContextOperator'
        type:
          $ref: '#/components/schemas/FacilityDiscountContextTypes'
        values:
          description: >-
            The values of the context. This is used to determine the conditions 
            under which the discount can be applied.
          items:
            example: uuid-bkrs-0157
            maxItems: 100
            minItems: 0
            type: string
          type: array
      required:
        - type
        - values
      type: object
      title: FacilityDiscountContext
    FacilityDiscountContextTypes:
      description: >-
        The context type of the discount. This is used to determine the
        conditions  under which the discount can be applied.
      enum:
        - FACILITY
        - FACILITY_GROUP
        - CATEGORY
      type: string
      title: FacilityDiscountContextTypes
    FacilityDiscountForCreation:
      additionalProperties: false
      properties:
        context:
          description: >-
            The context of the discount. This is used to determine the
            conditions  under which the discount can be applied.
          items:
            $ref: '#/components/schemas/FacilityDiscountContext'
            maxLength: 2000
            minItems: 0
          type: array
        discount:
          oneOf:
            - $ref: '#/components/schemas/FacilityDiscountRelative'
            - $ref: '#/components/schemas/FacilityDiscountAbsoluteForCreation'
        priority:
          description: >-
            The priority of the discount. Discounts with the lowest priority
            value are applied first. Value must be greater than 0 and smaller
            than 1000.
          example: 1
          type: integer
        type:
          $ref: '#/components/schemas/FacilityDiscountPriceType'
      required:
        - discount
        - priority
        - type
      title: FacilityDiscountForCreation
      description: FacilityDiscountForCreation
    FacilityDiscountForUpdate:
      additionalProperties: false
      properties:
        context:
          description: >-
            The context of the discount. This is used to determine the
            conditions  under which the discount can be applied.
          items:
            $ref: '#/components/schemas/FacilityDiscountContext'
            maxLength: 2000
            minItems: 0
          type: array
        discount:
          oneOf:
            - $ref: '#/components/schemas/FacilityDiscountRelative'
            - $ref: '#/components/schemas/FacilityDiscountAbsoluteForCreation'
        priority:
          description: >-
            The priority of the discount. Discounts with the lowest priority
            value are applied first. Must be greater than 0 and smaller than
            1000.
          example: 1
          type: integer
        type:
          $ref: '#/components/schemas/FacilityDiscountPriceType'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      title: FacilityDiscountForUpdate
      description: FacilityDiscountForUpdate
    FacilityDiscountPaginatedResult:
      additionalProperties: false
      properties:
        items:
          description: >-
            The list of discounts that match the search criteria. The list might
            be empty if no discounts match the search criteria.
          items:
            $ref: '#/components/schemas/FacilityDiscount'
          type: array
        total:
          description: >-
            The total number of discounts that match the search criteria. This
            number is not limited by the page size.
          example: 42
          format: int64
          type: integer
      required:
        - items
        - total
      title: FacilityDiscountPaginatedResult
      description: FacilityDiscountPaginatedResult
    FacilityDiscountPriceType:
      description: Determines the price type this discount can be applied to.
      enum:
        - SALES_PRICE
      type: string
      title: FacilityDiscountPriceType
    FacilityDiscountRelative:
      additionalProperties: false
      properties:
        type:
          enum:
            - RELATIVE
          type: string
        value:
          description: Provided discount in percent.
          example: 7.1
          minimum: 0.1
          type: number
      required:
        - type
        - value
      type: object
      title: FacilityDiscountRelative
      description: FacilityDiscountRelative
    FacilityDiscountType:
      description: >-
        The type of the discount. This is used to determine the conditions 
        under which the discount can be applied.
      enum:
        - ABSOLUTE
        - RELATIVE
      type: string
      title: FacilityDiscountType
    FacilityFacilityCarrierConnectionFilter:
      properties:
        carrierKey:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Filter facilities by configured carrier key
      title: FacilityFacilityCarrierConnectionFilter
      type: object
      description: FacilityFacilityCarrierConnectionFilter
    FacilityForCreation:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the facility. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        name:
          example: Hamburg NW2
          type: string
        operativeCosts:
          items:
            $ref: '#/components/schemas/FacilityOperativeCostForCreation'
          maxItems: 1
          type: array
        status:
          $ref: '#/components/schemas/FacilityStatus'
        tenantFacilityId:
          description: The id of the facility in the tenants own system
          example: K12345
          type: string
        type:
          $ref: '#/components/schemas/FacilityType'
          default: MANAGED_FACILITY
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - name
      type: object
      xml:
        name: FacilityForCreation
      title: FacilityForCreation
      description: FacilityForCreation
    FacilityGroup:
      properties:
        nameLocalized:
          additionalProperties:
            type: string
          description: The localized name
          type: object
        created:
          description: Creation timestamp
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the facility group. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          nullable: true
          type: object
        facilityCount:
          description: The number of facilities in this group
          type: number
        facilityRefs:
          description: >-
            Array of facility references belonging to this group. Cannot exceed
            your quota, default 1000. Each facility can be assigned to at most
            20 facility groups (default).
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
          uniqueItems: true
        id:
          description: The facility group ID
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Last modified timestamp
          format: date-time
          type: string
        name:
          description: The name of the facility group
          type: string
        tenantFacilityGroupId:
          description: The id of the facility group in the tenants own system
          example: K12345
          type: string
        version:
          description: Document version for optimistic locking
          example: 1
          type: number
      required:
        - tenantFacilityGroupId
        - facilityRefs
        - nameLocalized
        - id
        - version
        - created
        - lastModified
        - facilityCount
      title: FacilityGroup
      type: object
      description: FacilityGroup
    FacilityGroupCreatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/FacilityGroup'
      required:
        - payload
      type: object
      title: FacilityGroupCreatedWebHookEvent
      description: FacilityGroupCreatedWebHookEvent
    FacilityGroupDeletedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          description: The id of the deleted facility group
          type: string
      required:
        - payload
      type: object
      title: FacilityGroupDeletedWebHookEvent
      description: FacilityGroupDeletedWebHookEvent
    FacilityGroupForCreation:
      properties:
        nameLocalized:
          additionalProperties:
            type: string
          description: The localized name
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the facility group. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          nullable: true
          type: object
        facilityRefs:
          description: >-
            Array of facility references belonging to this group. Cannot exceed
            your quota, default 1000. Each facility can be assigned to at most
            20 facility groups (default).
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
          uniqueItems: true
        tenantFacilityGroupId:
          description: The id of the facility group in the tenants own system
          example: K12345
          type: string
      required:
        - tenantFacilityGroupId
        - facilityRefs
        - nameLocalized
      title: FacilityGroupForCreation
      type: object
      description: FacilityGroupForCreation
    FacilityGroupForUpdate:
      properties:
        nameLocalized:
          additionalProperties:
            type: string
          description: The localized name
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the facility group. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          nullable: true
          type: object
        facilityRefs:
          description: >-
            Array of facility references belonging to this group. Cannot exceed
            your quota, default 1000. Each facility can be assigned to at most
            20 facility groups (default).
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
          uniqueItems: true
        tenantFacilityGroupId:
          description: The id of the facility group in the tenants own system
          example: K12345
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: number
      required:
        - version
      title: FacilityGroupForUpdate
      type: object
      description: FacilityGroupForUpdate
    FacilityGroupPaginatedResult:
      properties:
        facilityGroups:
          items:
            $ref: '#/components/schemas/FacilityGroup'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - facilityGroups
      title: FacilityGroupPaginatedResult
      type: object
      description: FacilityGroupPaginatedResult
    FacilityGroups:
      properties:
        facilityGroups:
          description: Array of facility groups
          items:
            $ref: '#/components/schemas/FacilityGroup'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: number
      title: FacilityGroups
      type: object
      description: FacilityGroups
    FacilityGroupSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/FacilityGroupSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/FacilityGroupSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: FacilityGroupSearchPayload
      type: object
      description: FacilityGroupSearchPayload
    FacilityGroupSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/FacilityGroupSearchQuery'
          maxItems: 500
          type: array
        facilityRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by facilityRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        name:
          allOf:
            - $ref: '#/components/schemas/LocalizedStringSearchFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/FacilityGroupSearchQuery'
          maxItems: 500
          type: array
        tenantFacilityGroupId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantFacilityGroupId
          example: MY_FACILITYGROUP_ID
      title: FacilityGroupSearchQuery
      type: object
      description: FacilityGroupSearchQuery
    FacilityGroupSort:
      properties:
        facilityCount:
          enum:
            - ASC
            - DESC
          type: string
        name:
          enum:
            - ASC
            - DESC
          type: string
        tenantFacilityGroupId:
          enum:
            - ASC
            - DESC
          type: string
      title: FacilityGroupSort
      type: object
      description: FacilityGroupSort
    FacilityGroupUpdatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/FacilityGroup'
      required:
        - payload
      type: object
      title: FacilityGroupUpdatedWebHookEvent
      description: FacilityGroupUpdatedWebHookEvent
    FacilityLocationType:
      default: STORE
      enum:
        - STORE
        - WAREHOUSE
        - EXTERNAL
      type: string
      xml:
        name: FacilityLocationType
      title: FacilityLocationType
      description: FacilityLocationType
    FacilityLocationTypeEnumFilter:
      properties:
        eq:
          description: Search by locationType
          enum:
            - STORE
            - WAREHOUSE
            - EXTERNAL
          type: string
        in:
          description: Search by locationType
          items:
            enum:
              - STORE
              - WAREHOUSE
              - EXTERNAL
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by locationType
          enum:
            - STORE
            - WAREHOUSE
            - EXTERNAL
          type: string
      title: FacilityLocationTypeEnumFilter
      type: object
      description: FacilityLocationTypeEnumFilter
    FacilityOperativeCost:
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          nullable: true
          type: string
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          minimum: 0
          type: integer
        value:
          description: >-
            Value of operational cost of the facility. Value is configured in
            the smallest subunit, e.g. cents.
          example: 25000
          minimum: 0
          type: integer
      required:
        - value
        - currency
        - decimalPlaces
      type: object
      title: FacilityOperativeCost
      description: FacilityOperativeCost
    FacilityOperativeCostForCreation:
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          nullable: true
          type: string
        decimalPlaces:
          description: >-
            Number of decimal places for the given currency. We be defaulted
            according to the currency if missing.
          example: 2
          minimum: 0
          type: integer
        value:
          description: >-
            Value of operational cost of the facility. Value is configured in
            the smallest subunit, e.g. cents.
          example: 25000
          minimum: 0
          type: integer
      required:
        - value
        - currency
      type: object
      title: FacilityOperativeCostForCreation
      description: FacilityOperativeCostForCreation
    FacilityOrderBy:
      description: Attribute to order a facility list
      enum:
        - NAME
        - CREATED
        - POSTAL_CODE_ASC
      type: string
      xml:
        name: FacilityOrderBy
      title: FacilityOrderBy
    FacilityPaginatedResult:
      properties:
        facilities:
          items:
            oneOf:
              - $ref: '#/components/schemas/ManagedFacility'
              - $ref: '#/components/schemas/Supplier'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - facilities
      title: FacilityPaginatedResult
      type: object
      description: FacilityPaginatedResult
    FacilityPatchActions:
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Deprecated; works only on managed facilities. Prefer to use
        ManagedFacilityForModification / SupplierForModification for full
        compatibility.
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyFacility'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: FacilityPatchActions
      title: FacilityPatchActions
      deprecated: true
    FacilityReferenceFilter:
      properties:
        facilityCarrierConnection:
          allOf:
            - $ref: '#/components/schemas/FacilityFacilityCarrierConnectionFilter'
          description: The referenced entity
      title: FacilityReferenceFilter
      type: object
      description: FacilityReferenceFilter
    FacilityRefLatestPickingStartPair:
      properties:
        facilityRef:
          description: Facility reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        latestPickingStart:
          description: Latest picking start date-time
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      required:
        - facilityRef
        - latestPickingStart
      title: FacilityRefLatestPickingStartPair
      type: object
      description: FacilityRefLatestPickingStartPair
    FacilityRefSelector:
      properties:
        facilityRef:
          description: >-
            Resolves a facility by its reference. This is the preferred way to
            resolve a facility.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          minLength: 1
          type: string
      required:
        - facilityRef
      title: FacilityRefSelector
      type: object
      description: FacilityRefSelector
    FacilitySearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/FacilitySearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/FacilitySort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: FacilitySearchPayload
      type: object
      description: FacilitySearchPayload
    FacilitySearchQuery:
      properties:
        address:
          allOf:
            - $ref: '#/components/schemas/FacilityAddressFilter'
          description: Nested search by address
        and:
          items:
            $ref: '#/components/schemas/FacilitySearchQuery'
          maxItems: 500
          type: array
        contact:
          allOf:
            - $ref: '#/components/schemas/FacilityContactFilter'
          description: Nested search by contact
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        locationType:
          allOf:
            - $ref: '#/components/schemas/FacilityLocationTypeEnumFilter'
          description: Search by locationType
        name:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/FacilitySearchQuery'
          maxItems: 500
          type: array
        referenced:
          allOf:
            - $ref: '#/components/schemas/FacilityReferenceFilter'
          description: References to other entities
        services:
          allOf:
            - $ref: '#/components/schemas/FacilityServicesListFilter'
          description: Nested list search by services
        status:
          allOf:
            - $ref: '#/components/schemas/FacilityStatusEnumFilter'
          description: Search by status
        tenantFacilityId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantFacilityId
          example: MY_FACILITY_ID
        type:
          allOf:
            - $ref: '#/components/schemas/FacilityTypeEnumFilter'
          description: Search by type
        tags:
          allOf:
            - $ref: '#/components/schemas/FacilityTagsListFilter'
          description: Nested list search by tags
      title: FacilitySearchQuery
      type: object
      description: FacilitySearchQuery
    FacilityService:
      additionalProperties: false
      properties:
        type:
          $ref: '#/components/schemas/FacilityServiceType'
      required:
        - type
      type: object
      xml:
        name: FacilityService
      title: FacilityService
      description: FacilityService
    FacilityServicesFacilityServiceTypeEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - SHIP_FROM_STORE
            - PICKUP
          type: string
        in:
          description: Search by type
          items:
            enum:
              - SHIP_FROM_STORE
              - PICKUP
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - SHIP_FROM_STORE
            - PICKUP
          type: string
      title: FacilityServicesFacilityServiceTypeEnumFilter
      type: object
      description: FacilityServicesFacilityServiceTypeEnumFilter
    FacilityServicesFilter:
      properties:
        type:
          allOf:
            - $ref: >-
                #/components/schemas/FacilityServicesFacilityServiceTypeEnumFilter
          description: Search by type
      title: FacilityServicesFilter
      type: object
      description: FacilityServicesFilter
    FacilityServicesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/FacilityServicesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: FacilityServicesListFilter
      type: object
      description: FacilityServicesListFilter
    FacilityServicesSort:
      properties:
        type:
          enum:
            - ASC
            - DESC
          type: string
      title: FacilityServicesSort
      type: object
      description: FacilityServicesSort
    FacilityServiceType:
      description: The description of the service this facility offers.
      enum:
        - SHIP_FROM_STORE
        - PICKUP
      type: string
      title: FacilityServiceType
    FacilitySort:
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddressSort'
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        id:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        locationType:
          enum:
            - ASC
            - DESC
          type: string
        name:
          enum:
            - ASC
            - DESC
          type: string
        services:
          $ref: '#/components/schemas/FacilityServicesSort'
        status:
          enum:
            - ASC
            - DESC
          type: string
        tenantFacilityId:
          enum:
            - ASC
            - DESC
          type: string
        type:
          enum:
            - ASC
            - DESC
          type: string
      title: FacilitySort
      type: object
      description: FacilitySort
    FacilityStatus:
      description: >-
        The state of the facility. ONLINE means that this facility can process
        new orders and pickjobs, SUSPENDED means it cannot get new orders but is
        able to fulfill the current workload and OFFLINE means that it cannot
        fulfill any new or existing orders. Processes already running might be
        rescheduled to another facility depending on the preferences.
      enum:
        - ONLINE
        - SUSPENDED
        - OFFLINE
      type: string
      title: FacilityStatus
    FacilityStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - ONLINE
            - SUSPENDED
            - OFFLINE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - ONLINE
              - SUSPENDED
              - OFFLINE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - ONLINE
            - SUSPENDED
            - OFFLINE
          type: string
      title: FacilityStatusEnumFilter
      type: object
      description: FacilityStatusEnumFilter
    FacilityStock:
      properties:
        available:
          type: number
        facilityRef:
          type: string
        id:
          type: string
        reserved:
          type: number
        tenantArticleId:
          type: string
        value:
          type: number
      required:
        - available
        - reserved
        - value
        - tenantArticleId
        - facilityRef
        - id
      title: FacilityStock
      type: object
      description: FacilityStock
    FacilityStockBulkOperation:
      properties:
        tenantArticleId:
          example: MY_ARTICLE_ID
          minLength: 1
          type: string
        value:
          minimum: 0
          type: number
      required:
        - tenantArticleId
        - value
      title: FacilityStockBulkOperation
      type: object
      description: FacilityStockBulkOperation
    FacilityStockBulkOperations:
      properties:
        operations:
          items:
            $ref: '#/components/schemas/FacilityStockBulkOperation'
          minItems: 1
          type: array
      required:
        - operations
      title: FacilityStockBulkOperations
      type: object
      description: FacilityStockBulkOperations
    FacilityStockBulkResult:
      properties:
        error:
          $ref: '#/components/schemas/BulkOperationError'
        facilityRef:
          type: string
        status:
          enum:
            - UPDATED
            - CREATED
            - FAILED
          type: string
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - facilityRef
        - status
      title: FacilityStockBulkResult
      type: object
      description: FacilityStockBulkResult
    FacilityStockConfiguration:
      properties:
        created:
          description: Creation timestamp
          format: date-time
          type: string
        id:
          description: The facility stock configuration ID (same as facility ID)
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Last modified timestamp
          format: date-time
          type: string
        listingReactivationAfter:
          allOf:
            - $ref: >-
                #/components/schemas/FacilityStockConfigurationListingReactivationAfter
          deprecated: true
          description: Configuration for listing reactivation timing
        retainedOfflineStock:
          allOf:
            - $ref: >-
                #/components/schemas/FacilityStockConfigurationRetainedOfflineStock
          deprecated: true
          description: >-
            Configuration for retained offline stock. Deprecated: Use safety
            stock instead.
        shortpick:
          allOf:
            - $ref: '#/components/schemas/FacilityStockConfigurationShortpick'
          description: Configuration for shortpick handling
        version:
          description: Document version for optimistic locking
          example: 1
          type: number
      required:
        - id
        - version
        - listingReactivationAfter
        - retainedOfflineStock
        - shortpick
      title: FacilityStockConfiguration
      type: object
      description: FacilityStockConfiguration
    FacilityStockConfigurationListingReactivationAfter:
      properties:
        active:
          default: true
          description: The disabling of listings is enabled or disabled.
          example: true
          type: boolean
        value:
          default: 24
          description: >-
            Time in hours that has to pass for a deactivated listing (e.g. due
            to manual deactivation or as a result of a shortpick) to become
            active again.
          example: 24
          type: number
      title: FacilityStockConfigurationListingReactivationAfter
      type: object
      description: FacilityStockConfigurationListingReactivationAfter
    FacilityStockConfigurationRetainedOfflineStock:
      properties:
        active:
          deprecated: true
          description: The retained Offline Stock is enabled or disabled.
          type: boolean
        value:
          default: 0.2
          deprecated: true
          description: >-
            The overall percentage of stock that should be reserved to offline
            clients.
          example: 0.15
          maximum: 1
          minimum: 0.01
          type: number
      title: FacilityStockConfigurationRetainedOfflineStock
      type: object
      description: FacilityStockConfigurationRetainedOfflineStock
    FacilityStockConfigurationShortpick:
      properties:
        active:
          default: true
          description: Inventory adjustment in the case of insufficient order picking
          example: true
          type: boolean
      required:
        - active
      title: FacilityStockConfigurationShortpick
      type: object
      description: FacilityStockConfigurationShortpick
    FacilityStockDistribution:
      properties:
        available:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          minimum: 0
          type: number
        availableForPicking:
          type: number
        availableOnStock:
          type: number
        availableToPromise:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        byTrait:
          $ref: '#/components/schemas/ByTrait'
        channelAdjusted:
          items:
            $ref: '#/components/schemas/ChannelStockAvailability'
          type: array
        facilityId:
          type: string
        facilityName:
          type: string
        facilityServiceTypes:
          items:
            $ref: '#/components/schemas/FacilityServiceType'
          type: array
        facilityStatus:
          $ref: '#/components/schemas/FacilityStatus'
        price:
          deprecated: true
          description: >-
            Use listings attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          nullable: true
          type: number
        readyToPick:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        reserved:
          minimum: 0
          type: number
        safetyStock:
          minimum: 0
          type: number
        stockOnHand:
          type: number
        totalAmount:
          minimum: 0
          type: number
      required:
        - reserved
        - totalAmount
        - available
        - safetyStock
        - byTrait
        - availableForPicking
        - availableToPromise
        - readyToPick
        - availableOnStock
        - stockOnHand
        - facilityId
        - facilityName
      title: FacilityStockDistribution
      type: object
      description: FacilityStockDistribution
    FacilitySuspendedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ManagedFacility'
      required:
        - payload
      type: object
      title: FacilitySuspendedWebHookEvent
      description: FacilitySuspendedWebHookEvent
    FacilityTagsFilter:
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        value:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by value
      title: FacilityTagsFilter
      type: object
      description: FacilityTagsFilter
    FacilityTagsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/FacilityTagsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: FacilityTagsListFilter
      type: object
      description: FacilityTagsListFilter
    FacilityType:
      default: MANAGED_FACILITY
      enum:
        - MANAGED_FACILITY
        - SUPPLIER
      type: string
      xml:
        name: FacilityType
      title: FacilityType
      description: FacilityType
    FacilityTypeEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - MANAGED_FACILITY
            - SUPPLIER
          type: string
        in:
          description: Search by type
          items:
            enum:
              - MANAGED_FACILITY
              - SUPPLIER
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - MANAGED_FACILITY
            - SUPPLIER
          type: string
      title: FacilityTypeEnumFilter
      type: object
      description: FacilityTypeEnumFilter
    FacilityUpdatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ManagedFacility'
      required:
        - payload
      type: object
      title: FacilityUpdatedWebHookEvent
      description: FacilityUpdatedWebHookEvent
    FacilityWentOfflineWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ManagedFacility'
      required:
        - payload
      type: object
      title: FacilityWentOfflineWebHookEvent
      description: FacilityWentOfflineWebHookEvent
    FacilityWentOnlineWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ManagedFacility'
      required:
        - payload
      type: object
      title: FacilityWentOnlineWebHookEvent
      description: FacilityWentOnlineWebHookEvent
    FallbackFacilityConfiguration:
      deprecated: true
      description: '@deprecated use RoutingStrategyFallbackFacilityConfiguration instead'
      properties:
        active:
          default: false
          type: boolean
        facilityRefs:
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        fallbackAfterTime:
          default: PT0H
          description: >-
            Default amount of time in ISO 8601 duration format after which a not
            routable routingplan is routed to a configured fallback facility.
          pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
      required:
        - facilityRefs
        - active
        - fallbackAfterTime
      title: FallbackFacilityConfiguration
    FallbackFacilityConfigurationForPatch:
      deprecated: true
      description: '@deprecated use RoutingStrategyFallbackFacilityConfiguration instead'
      properties:
        active:
          type: boolean
        facilityRefs:
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        fallbackAfterTime:
          description: >-
            Default amount of time in ISO 8601 duration format after which a not
            routable routingplan is routed to a configured fallback facility.
          pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
      title: FallbackFacilityConfigurationForPatch
    Feature:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        name:
          type: string
        status:
          $ref: '#/components/schemas/FeatureStatus'
      required:
        - name
        - status
      type: object
      title: Feature
      description: Feature
    FeaturePatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyFeature'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: FeaturePatchActions
      title: FeaturePatchActions
      description: FeaturePatchActions
    FeatureStatus:
      enum:
        - enabled
        - inactive
        - disabled
      type: string
      title: FeatureStatus
      description: FeatureStatus
    FedexCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultCommodityDescription:
          description: Default commodity description
          type: string
        defaultManufactureCountry:
          description: Default manufacture country
          example: DE
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        defaultPriceCurrency:
          description: Default price currency for shipments
          example: EUR
          type: string
        defaultPriceValue:
          description: Default price value for shipments
          type: number
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        useEconomyService:
          description: Whether to use the economy service
          type: boolean
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
        - useEconomyService
        - defaultPriceValue
        - defaultPriceCurrency
        - defaultManufactureCountry
        - defaultCommodityDescription
      title: FedexCarrierConfiguration
      type: object
      description: FedexCarrierConfiguration
    Fence:
      additionalProperties: false
      properties:
        active:
          type: boolean
        activeMode:
          $ref: '#/components/schemas/FenceMode'
        description:
          type: string
        id:
          description: >-
            This value identifies this very instance of the fence. It is set
            autmatically by the server when the configuration is updated.
          example: f937bc6b-d78b-46a3-913f-ecbba5f9f65d
          type: string
        implementation:
          $ref: '#/components/schemas/FenceImplementation'
        name:
          type: string
        supportedModes:
          items:
            $ref: '#/components/schemas/FenceMode'
          type: array
      required:
        - active
        - implementation
        - id
      type: object
      title: Fence
      description: Fence
    FenceAnalysis:
      properties:
        fenceId:
          description: The ID of the fence.
          type: string
        fenceName:
          description: The name of the fence.
          type: string
        fenceType:
          description: The type of fence.
          enum:
            - STANDARD
            - TOOLKIT
          type: string
        layer:
          description: The layer at which the fence was evaluated.
          type: number
        listingId:
          description: The ID of the listing.
          type: string
        nodeId:
          description: The ID of the node.
          type: string
        result:
          description: The result of the fence evaluation.
          enum:
            - PASSED
            - FAILED
            - NOT_APPLICABLE
          type: string
      required:
        - fenceType
        - nodeId
        - fenceId
        - result
      title: FenceAnalysis
      type: object
      description: FenceAnalysis
    FenceImplementation:
      description: >-
        <i>This part of the API is currently under development. That means that
        this endpoint, model, etc. can contain breaking changes and/or might not
        be available at all times in your API instance. It could also disappear
        without warning. It currently does not fall under our SLA regulations.
        For details, see our <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview">API
        lifecycle documentation</a></i>
      enum:
        - FACILITY-BUSINESSTYPE
        - STOCK-AVAILABILITY
        - FACILITY-CARRIERAVAILABILITY
        - FACILITY-COUNTRY
        - FACILITY-PICKING-TIME-CAPACITY
        - PRESELECTED-FACILITY
        - SAMEDAY-POSSIBLE
        - AVOID-ZERO-STOCK
      type: string
      xml:
        name: FenceImplementation
      title: FenceImplementation
    FenceMode:
      enum:
        - static
        - reactive
      type: string
      title: FenceMode
      description: FenceMode
    FenceResultStatus:
      enum:
        - FAILED
        - PASSED
        - REACTIVE_PASSING_POSSIBLE
      title: FenceResultStatus
      description: FenceResultStatus
    FenceStatistic:
      properties:
        durationMs:
          description: Duration in Milliseconds
          type: number
        name:
          type: string
        passedAmount:
          type: number
        passedPercentage:
          type: number
        rejectedAmount:
          type: number
      required:
        - name
        - rejectedAmount
        - passedAmount
        - passedPercentage
        - durationMs
      title: FenceStatistic
      description: FenceStatistic
    FFTActivityNode:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowNameLocaleString'
          description: Localized name of the node
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowDescriptionLocaleString'
          description: Localized description of the node
        description:
          description: Description resolved to the requesting user's locale (read-only)
          type: string
        key:
          description: Unique identifier for this node within the workflow
          type: string
        name:
          description: Name resolved to the requesting user's locale (read-only)
          type: string
        type:
          description: >-
            Type of the workflow node - module nodes that map to business
            entities
          enum:
            - ORDER_MODULE
            - PICKING_MODULE
            - PACKING_MODULE
            - HANDOVER_MODULE
            - RESERVATION_MODULE
            - ROUTING_MODULE
            - SHIPPING_MODULE
            - SERVICES_MODULE
          type: string
      required:
        - key
        - type
      title: FFTActivityNode
      type: object
      description: FFTActivityNode
    FilterEntity:
      properties:
        valueLocalized:
          $ref: '#/components/schemas/LocaleString'
        id:
          example: fsfdsf87fsd
          type: string
        type:
          $ref: '#/components/schemas/SupportedFilterEntityTypesEnum'
        value:
          example: stickerValue
          type: string
      required:
        - valueLocalized
        - id
        - type
      type: object
      xml:
        name: FilterEntity
      title: FilterEntity
      description: FilterEntity
    FinishHandoverJobActionEnum:
      enum:
        - FINISH_HANDOVER_JOB
      type: string
      title: FinishHandoverJobActionEnum
      description: FinishHandoverJobActionEnum
    FinishHandoverJobActionParameter:
      additionalProperties: false
      description: Action to finish a handoverjob.
      properties:
        lineItems:
          additionalProperties: false
          items:
            $ref: '#/components/schemas/FinishHandoverJobLineItem'
          type: array
        name:
          $ref: '#/components/schemas/FinishHandoverJobActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - lineItems
      title: FinishHandoverJobActionParameter
    FinishHandoverJobLineItem:
      additionalProperties: false
      properties:
        handedOverQuantity:
          type: number
        id:
          type: string
        refused:
          items:
            $ref: '#/components/schemas/RefusedItemForUpdate'
          type: array
        substituteLineItems:
          items:
            $ref: '#/components/schemas/FinishHandoverJobSubstituteLineItem'
          type: array
      required:
        - id
        - handedOverQuantity
      title: FinishHandoverJobLineItem
      description: FinishHandoverJobLineItem
    FinishHandoverJobSubstituteLineItem:
      properties:
        handedOverQuantity:
          minimum: 0
          type: integer
        id:
          type: string
        refused:
          items:
            $ref: '#/components/schemas/RefusedItemForUpdate'
          type: array
      required:
        - id
        - handedOverQuantity
      title: FinishHandoverJobSubstituteLineItem
      description: FinishHandoverJobSubstituteLineItem
    FinishItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - FinishItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: FinishItemReturnActionParameter
      type: object
      description: FinishItemReturnActionParameter
    FinishItemReturnJobActionParameter:
      properties:
        name:
          enum:
            - FinishItemReturnJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - version
        - name
      title: FinishItemReturnJobActionParameter
      type: object
      description: FinishItemReturnJobActionParameter
    FinishPickRun:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: Use value 'FinishPickRun', because you want to finish a pickrun
              enum:
                - FinishPickRun
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/pickruns/:id/actions instead
      title: FinishPickRun
      xml:
        name: FinishPickRun
    FixedCountConfiguration:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Configuration of fixed count split.
      properties:
        maxSplitCount:
          description: >-
            This setting defines how often an order split might be performed to
            fulfill the order.
          minimum: 1
          type: number
      required:
        - maxSplitCount
      type: object
      title: FixedCountConfiguration
      x-badges:
        - color: orange
          label: BETA
    FloatValidation:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/BaseValidation'
      description: Validate input as float.
      properties:
        maxValue:
          type: number
        minValue:
          type: number
      title: FloatValidation
      type: object
    FulfillmentProcessBufferConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        minutes:
          default: 240
          description: Duration in minutes until an order is processed
          example: '240'
          minimum: 0
          type: integer
      required:
        - minutes
      type: object
      title: FulfillmentProcessBufferConfiguration
      description: FulfillmentProcessBufferConfiguration
    GdprConfiguration:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        actorAnonymization:
          default: true
          description: >-
            If true, the actor information will be stored anonymized for
            auditing. Might take up to 1 hour to be take into effect
          example: true
          type: boolean
        deletionTimeAfterRetention:
          description: Number of days since anonymization until deletion is triggered
          example: 30
          minimum: 1
          type: number
        id:
          type: string
        retentionTime:
          description: Number of days after that anonymization is triggered.
          example: 30
          minimum: 1
          type: number
        version:
          example: 42
          format: int64
          type: integer
      required:
        - retentionTime
        - version
      type: object
      title: GdprConfiguration
      description: GdprConfiguration
    GeoFence:
      description: >-
        Center (described with lon and lat attributes) and a circular geofence
        (described as radius around the center)
      properties:
        lat:
          description: The latitude of the center, provided as decimal coordinate
          example: 50.968713
          type: number
        lon:
          description: The longitude of the center, provided as decimal coordinate
          example: 7.011375
          type: number
        radius:
          description: Radius around the center in kilometers (km, max. 100)
          minimum: 1
          type: number
      required:
        - lat
        - lon
        - radius
      type: object
      title: GeoFence
    GetParcelInformationListParams:
      properties:
        facilityRefs:
          description: filter by facilityRefs
          example:
            - 019eefb2-0001-7000-9000-100000000002
          items:
            type: string
          maxItems: 50
          type: array
        orderBy:
          description: >-
            the value by which results should be ordered by. If nothing is
            passed return values are sorted by id
          example: LAST_MODIFIED_DESC
          type: string
        shippingInformationRef:
          description: filter by shippingInformationRef
          example: 019eefb2-0001-7000-9000-100000000001
          type: string
        size:
          default: 25
          description: number of entities to show. Max value is 500
          example: 25
          maximum: 500
          minimum: 1
          type: integer
        startAfterId:
          description: entity to start after
          example: 019eefb1-4bd1-7ef0-98ba-f91e07243ea7
          type: string
        withTotal:
          description: >-
            if set to true, the total count of entities will be returned.
            Default is false
          example: true
          type: boolean
      title: GetParcelInformationListParams
      type: object
      description: GetParcelInformationListParams
    GetShippingInformationParams:
      properties:
        facilityRefs:
          description: filter by facilityRefs
          example:
            - 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          items:
            type: string
          maxItems: 50
          type: array
        orderBy:
          description: >-
            the value by which results should be ordered by. If nothing is
            passed return values are sorted by id
          example: CREATED_ASC
          type: string
        size:
          default: 25
          description: number of entities to show. Max value is 500
          example: 25
          maximum: 500
          minimum: 1
          type: integer
        startAfterId:
          description: entity to start after
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        tenantOrderId:
          description: filter by tenantOrderId
          example: ORDER-12345
          type: string
        withTotal:
          description: >-
            if set to true, the total count of entities found by the given
            search criteria will be returned. Default is false
          example: true
          type: boolean
      title: GetShippingInformationParams
      type: object
      description: GetShippingInformationParams
    GlobalManualRerouteConfiguration:
      description: Allows reroutes to be triggered manually via api.
      properties:
        active:
          type: boolean
      required:
        - active
      type: object
      title: GlobalManualRerouteConfiguration
    GlobalRoutingConfiguration:
      description: Global configuration for routing
      properties:
        defaultPrice:
          default: 10
          description: Default price which is used if no price exists in order or listings
          type: number
        fallbackFacilityConfiguration:
          $ref: '#/components/schemas/FallbackFacilityConfiguration'
        manualReroute:
          $ref: '#/components/schemas/GlobalManualRerouteConfiguration'
        routingTimeout:
          default: 8
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated Default amount of hours after which a routing plan is
            marked not routable. This field is deprecated in favour of
            stopRoutingAttemptsAfterTime
          type: number
        stopRoutingAttemptsAfterTime:
          default: PT8H
          description: >-
            Default amount of time in ISO 8601 duration format after which a
            routing plan is marked not routable. The duration need to be a
            multiple of 60 seconds.
          pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
      required:
        - defaultPrice
      type: object
      title: GlobalRoutingConfiguration
    GlsCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeReturnAddressLocationId:
          description: Alternative return address location ID
          type: string
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        alternativeSendAddressLocationId:
          description: Alternative send address location ID
          type: string
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        trackAndTraceWsdlUrl:
          description: WSDL URL for track and trace
          example: https://example.com/resource
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: GlsCarrierConfiguration
      type: object
      description: GlsCarrierConfiguration
    GuardWorkflowNode:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowNameLocaleString'
          description: Localized name of the node
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowDescriptionLocaleString'
          description: Localized description of the node
        condition:
          description: 'Guard condition: an expression or a built-in (preconfigured) guard.'
          discriminator:
            mapping:
              EXPRESSION: '#/components/schemas/ExpressionGuardCondition'
              PRECONFIGURED: '#/components/schemas/PreconfiguredGuardCondition'
            propertyName: kind
          oneOf:
            - $ref: '#/components/schemas/ExpressionGuardCondition'
            - $ref: '#/components/schemas/PreconfiguredGuardCondition'
        description:
          description: Description resolved to the requesting user's locale (read-only)
          type: string
        key:
          description: Unique identifier for this node within the workflow
          type: string
        name:
          description: Name resolved to the requesting user's locale (read-only)
          type: string
        type:
          description: Type of the workflow node
          enum:
            - GUARD
          type: string
      required:
        - key
        - type
        - condition
      title: GuardWorkflowNode
      type: object
      description: GuardWorkflowNode
    HandledItem:
      properties:
        quantity:
          minimum: 1
          type: number
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
      type: object
      title: HandledItem
      description: HandledItem
    HandoverConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        availableRefusedReasons:
          items:
            $ref: '#/components/schemas/AvailableRefusedReason'
          type: array
        createStandaloneHandoverJobs:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />If true, a handover job will be created out of a valid routing
            plan. It is only possible, if no pickjob nor pack jobs are used for
            this tenant. This is a alpha feature and might be completely
            replaced in the future. Please only use in communication with the
            fulfillmenttools team.
          example: true
          type: boolean
      type: object
      title: HandoverConfiguration
      description: HandoverConfiguration
    HandoverConfigurationForCreate:
      additionalProperties: false
      properties:
        availableRefusedReasons:
          items:
            $ref: '#/components/schemas/AvailableRefuseReasonForCreation'
          type: array
        createStandaloneHandoverJobs:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />If true, a handover job will be created out of a valid routing
            plan. It is only possible, if no pickjob nor packjobs are used for
            this tenant. This is a alpha feature and might be completly replaced
            in the future. Please only use in communication with the FFT team.
          example: true
          type: boolean
        version:
          type: number
      required:
        - version
      type: object
      title: HandoverConfigurationForCreate
      description: HandoverConfigurationForCreate
    HandoverContainer:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        codes:
          items:
            type: string
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          type: object
        description:
          description: Translated Description from descriptionLocalized
          type: string
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        facilityRef:
          description: Linked Facility through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        handoverJobRef:
          description: Linked HandoverJob through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        iconUrl:
          description: URL to icon
          example: https://example.com/resource
          type: string
        id:
          description: Unique identifier of the handover container
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        lineItems:
          items:
            $ref: '#/components/schemas/HandoverContainerLineItem'
          type: array
        name:
          description: Translated name from nameLocalized
          type: string
        operativeContainerTypeRef:
          description: Linked Operative Container Type through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        previousModuleContainerInfo:
          $ref: '#/components/schemas/PreviousModuleContainerInfo'
        processRef:
          description: Linked Process through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        sequenceNumber:
          example: 42
          format: int32
          maximum: 10000
          minimum: 0
          type: integer
        stackRef:
          description: Linked stack through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: Linked StorageLocation through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        type:
          description: Type of the container. Can either be PHYSICAL or VIRTUAL.
          enum:
            - PHYSICAL
            - VIRTUAL
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        weightLimitInG:
          description: Weight limit in gram for this Container
          example: 42
          type: integer
      required:
        - created
        - lastModified
        - version
        - id
        - facilityRef
        - processRef
        - stackRef
        - lineItems
        - handoverJobRef
        - nameLocalized
        - type
      title: HandoverContainer
      type: object
      description: HandoverContainer
    HandoverContainerForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        codes:
          items:
            type: string
          maxItems: 50
          type: array
        customAttributes:
          type: object
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        handoverJobRef:
          description: Linked HandoverJob through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        iconUrl:
          description: URL to icon
          example: https://example.com/resource
          type: string
        lineItems:
          items:
            $ref: '#/components/schemas/HandoverContainerLineItemForCreation'
          maxItems: 50
          type: array
        operativeContainerTypeRef:
          description: Linked Operative Container Type through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        previousModuleContainerInfo:
          $ref: '#/components/schemas/PreviousModuleContainerInfo'
        sequenceNumber:
          example: 42
          format: int32
          maximum: 10000
          minimum: 0
          type: integer
        stackRef:
          description: Linked Stack through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: Linked StorageLocation through reference
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        weightLimitInG:
          description: Weight limit in gram for this Container
          example: 42
          type: integer
      required:
        - handoverJobRef
        - lineItems
        - nameLocalized
      title: HandoverContainerForCreation
      type: object
      description: HandoverContainerForCreation
    HandoverContainerLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/HandoverContainerLineItemArticle'
          description: Information about the lineItem
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: ID of the recordable attribute
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: Amount per line item
          example: 42
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - id
        - article
        - quantity
      title: HandoverContainerLineItem
      type: object
      description: HandoverContainerLineItem
    HandoverContainerLineItemArticle:
      properties:
        titleLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations for the title of the product
        attributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 50
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Ensure that no
            authentication is needed to fetch the image.
          example: https://example.com/resource
          type: string
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          description: Weight value is in gram
          minimum: 0
          type: number
      required:
        - tenantArticleId
        - title
      title: HandoverContainerLineItemArticle
      type: object
      description: HandoverContainerLineItemArticle
    HandoverContainerLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/HandoverContainerLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: Amount per line item
          example: 42
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - article
        - quantity
      title: HandoverContainerLineItemForCreation
      type: object
      description: HandoverContainerLineItemForCreation
    Handoverjob:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            assignedUsers:
              description: Assigned users for this entity
              items:
                $ref: '#/components/schemas/AssignedUser'
              type: array
            cancelReason:
              $ref: '#/components/schemas/HandoverJobCancelReason'
            carrierKey:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo instead.
              type: string
              deprecated: true
            carrierLogoUrl:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo instead.
              type: string
              deprecated: true
            carrierRef:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo instead.
              type: string
              deprecated: true
            carrierTrackingNumber:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo instead.
              type: string
              deprecated: true
            channel:
              $ref: '#/components/schemas/HandoverjobChannel'
            customAttributes:
              description: >-
                Attributes that can be added to the handover job. These
                attributes cannot be used within fulfillment processes, but it
                could be useful to have the informations carried here.
              type: object
            documents:
              items:
                $ref: '#/components/schemas/PrintableDocument'
              type: array
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            expectedHandoverJobLineItems:
              items:
                $ref: '#/components/schemas/ExpectedHandoverLineItem'
              type: array
            facilityRef:
              description: The id of the facility reference.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            fullIdentifier:
              description: An information to identify the recipient
              type: string
            handoverJobLineItems:
              items:
                $ref: '#/components/schemas/HandoverLineItem'
            handoverJobParcelInfo:
              $ref: '#/components/schemas/HandoverJobParcelInfo'
            id:
              description: >-
                The id of this handoverjob. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: 95EWrieX09OmeriXIUbb
              type: string
            invoiceAddress:
              $ref: '#/components/schemas/ConsumerAddress'
            loadUnitRefs:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />This field is deprecated since 30 April 2026.
                HandoverJobs should not be aware of load units. The relation to
                load units are via handover container, if there ist a relation.
              items:
                type: string
              type: array
              deprecated: true
            missingHandoverJobLineItems:
              items:
                $ref: '#/components/schemas/MissingHandoverJobLineItem'
              type: array
            operativeProcessRef:
              type: string
            orderDate:
              description: The date this order was created at the supplying system.
              example: 2020-02-03T08:45:50.525Z
              format: date-time
              type: string
            paid:
              description: Indicates if the order is already paid
              example: false
              type: boolean
            parcelRef:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo instead.
              example: 2fOge2ZGW54K4TgvDTQw
              type: string
              deprecated: true
            pickJobRef:
              description: >-
                The reference to the pickjob for which the handoverjob is
                assigned to
              example: ca525716-7208-4a63-a2a6-11274eb37f67-0
              type: string
            processId:
              description: >-
                Id of the global process related to this entity. For example
                used for starting the GDPR process and others.
              type: string
            recipientAddress:
              $ref: '#/components/schemas/ConsumerAddress'
            shipmentRef:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo instead.
              example: Esb20gpHBL94X5NdMp3C
              type: string
              deprecated: true
            shortIdentifier:
              description: The short identifier of the shipment.
              type: string
            status:
              $ref: '#/components/schemas/HandoverjobStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            targetTime:
              description: >-
                The time the handoverjob is expected to be picked up at the
                facility.
              format: date-time
              type: string
            tenantOrderId:
              description: >-
                Field can be used as a reference number in foreign systems, for
                example as a reference to the source system's identifier for
                this order.
              example: R456728546
              type: string
            transfers:
              items:
                $ref: '#/components/schemas/OperativeTransfer'
              minItems: 0
              type: array
            workflowInformation:
              oneOf:
                - $ref: '#/components/schemas/WorkflowInformation'
                - $ref: '#/components/schemas/WorkflowUnavailable'
            tags:
              description: >-
                Tags can only be set when there is no process related with this
                handoverJob. Setting processId and tags will lead to an
                validationError.
              items:
                $ref: '#/components/schemas/TagReference'
              minItems: 1
              type: array
      required:
        - id
        - status
        - facilityRef
        - targetTime
        - channel
        - orderDate
        - workflowInformation
      type: object
      title: Handoverjob
      description: Handoverjob
    HandoverJobActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/HandoverJobCancelActionParameter'
        - $ref: '#/components/schemas/HandoverJobLineItemUpdateActionParameter'
        - $ref: '#/components/schemas/FinishHandoverJobActionParameter'
        - $ref: '#/components/schemas/SetHandoverJobToWaitingForInputActionParameter'
        - $ref: '#/components/schemas/HandoverJobReplaceAssignedUsersActionParameter'
        - $ref: '#/components/schemas/HandoverJobSplitLineItemsActionParameter'
        - $ref: >-
            #/components/schemas/UpdateHandoverLineItemRecordableAttributesActionParameter
        - $ref: '#/components/schemas/MoveHandoverJobLineItemsActionParameter'
        - $ref: '#/components/schemas/HandoverJobAddTargetTimeActionParameter'
      title: HandoverJobActionsParameter
      description: HandoverJobActionsParameter
    HandoverJobAddTargetTimeActionEnum:
      enum:
        - ADD_TARGET_TIME
      type: string
      title: HandoverJobAddTargetTimeActionEnum
      description: HandoverJobAddTargetTimeActionEnum
    HandoverJobAddTargetTimeActionParameter:
      additionalProperties: false
      description: >-
        Action to add targetTime to a HandoverJob that has none. Will fail if
        targetTime is already set
      properties:
        name:
          $ref: '#/components/schemas/HandoverJobAddTargetTimeActionEnum'
        targetTime:
          description: The target time you want set for the given handoverJob.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - targetTime
      title: HandoverJobAddTargetTimeActionParameter
      type: object
    HandoverJobAssignedUsersFilter:
      properties:
        userId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by userId
        username:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by username
      title: HandoverJobAssignedUsersFilter
      type: object
      description: HandoverJobAssignedUsersFilter
    HandoverJobAssignedUsersListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/HandoverJobAssignedUsersFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: HandoverJobAssignedUsersListFilter
      type: object
      description: HandoverJobAssignedUsersListFilter
    HandoverJobCancelActionEnum:
      enum:
        - CANCEL
      type: string
      title: HandoverJobCancelActionEnum
      description: HandoverJobCancelActionEnum
    HandoverJobCancelActionParameter:
      additionalProperties: false
      description: Action to cancel a handoverjob.
      properties:
        name:
          $ref: '#/components/schemas/HandoverJobCancelActionEnum'
        payload:
          additionalProperties: false
          properties:
            handoverJobCancelReason:
              $ref: '#/components/schemas/HandoverJobCancelReason'
          required:
            - handoverJobCancelReason
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - payload
      title: HandoverJobCancelActionParameter
    HandoverJobCancelReason:
      enum:
        - CONSUMER_NO_SHOW
        - CONSUMER_REJECTS
        - ORDER_CANCELED
      type: string
      title: HandoverJobCancelReason
      description: HandoverJobCancelReason
    HandoverjobChannel:
      enum:
        - DELIVERY
        - COLLECT
      type: string
      title: HandoverjobChannel
      description: HandoverjobChannel
    HandoverJobChannelEnumEnumFilter:
      properties:
        eq:
          description: Search by channel
          enum:
            - DELIVERY
            - COLLECT
          type: string
        in:
          description: Search by channel
          items:
            enum:
              - DELIVERY
              - COLLECT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by channel
          enum:
            - DELIVERY
            - COLLECT
          type: string
      title: HandoverJobChannelEnumEnumFilter
      type: object
      description: HandoverJobChannelEnumEnumFilter
    HandoverjobForCreation:
      additionalProperties: false
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          type: array
        cancelReason:
          $ref: '#/components/schemas/HandoverJobCancelReason'
        carrierLogoUrl:
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 28 November 2024. Use
            nested object handoverJobParcelInfo instead.
          type: string
          deprecated: true
        carrierRef:
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 28 November 2024. Use
            nested object handoverJobParcelInfo instead.
          type: string
          deprecated: true
        carrierTrackingNumber:
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 28 November 2024. Use
            nested object handoverJobParcelInfo instead.
          type: string
          deprecated: true
        channel:
          $ref: '#/components/schemas/HandoverjobChannel'
        customAttributes:
          description: >-
            Attributes that can be added to the handover job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        expectedHandoverJobLineItems:
          items:
            $ref: '#/components/schemas/ExpectedHandoverLineItemForCreation'
          type: array
        facilityRef:
          description: The id of the facility reference.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        fullIdentifier:
          description: An information to identify the recipient
          type: string
        handoverJobLineItems:
          items:
            $ref: '#/components/schemas/HandoverLineItemForCreation'
          type: array
        handoverJobParcelInfo:
          $ref: '#/components/schemas/HandoverJobParcelInfoForCreation'
        invoiceAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        loadUnitRefs:
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />This field is deprecated since 30 April 2026. HandoverJobs should
            not be aware of load units. The relation to load units are via
            handover container, if there ist a relation.
          items:
            type: string
          type: array
          deprecated: true
        missingHandoverJobLineItems:
          items:
            $ref: '#/components/schemas/MissingHandoverJobLineItemForCreation'
          type: array
        operativeProcessRef:
          type: string
        orderDate:
          description: The date this order was created at the supplying system.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        paid:
          description: Indicates if the order is already paid
          example: false
          type: boolean
        parcelRef:
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 28 November 2024. Use
            nested object handoverJobParcelInfo instead.
          example: 2fOge2ZGW54K4TgvDTQw
          type: string
          deprecated: true
        pickJobRef:
          description: >-
            The reference to the pickjob for which the handoverjob is assigned
            to
          example: ca525716-7208-4a63-a2a6-11274eb37f67-0
          type: string
        processId:
          description: >-
            Id of the global process related to this entity. For example used
            for starting the GDPR process and others.
          type: string
        recipientAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        routingPlanRef:
          description: >-
            The reference to the routing plan for which the handoverjob is
            assigned to
          example: ca525716-7208-4a63-a2a6-11274eb37f67-0
          type: string
        shipmentRef:
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 28 November 2024. Use
            nested object handoverJobParcelInfo instead.
          example: Esb20gpHBL94X5NdMp3C
          type: string
          deprecated: true
        shortIdentifier:
          description: The short identifier of the shipment.
          type: string
        status:
          $ref: '#/components/schemas/HandoverjobStatus'
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          minItems: 1
          type: array
        targetTime:
          description: >-
            The time the handoverjob is expected to be picked up at the
            facility.
          format: date-time
          type: string
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        transfers:
          items:
            $ref: '#/components/schemas/OperativeTransfer'
          minItems: 0
          type: array
        workflowInformation:
          oneOf:
            - $ref: '#/components/schemas/WorkflowInformation'
            - $ref: '#/components/schemas/WorkflowUnavailable'
        tags:
          description: >-
            Tags can only be set when there is no process related with this
            handoverJob. Setting processId and tags will lead to an
            validationError.
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - facilityRef
        - targetTime
        - channel
        - orderDate
      type: object
      title: HandoverjobForCreation
      description: HandoverjobForCreation
    HandoverJobHandoverJobLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by title
      title: HandoverJobHandoverJobLineItemsArticleFilter
      type: object
      description: HandoverJobHandoverJobLineItemsArticleFilter
    HandoverJobHandoverJobLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: >-
                #/components/schemas/HandoverJobHandoverJobLineItemsArticleFilter
          description: Nested search by article
        substituteLineItems:
          allOf:
            - $ref: >-
                #/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter
          description: Nested list search by substituteLineItems
      title: HandoverJobHandoverJobLineItemsFilter
      type: object
      description: HandoverJobHandoverJobLineItemsFilter
    HandoverJobHandoverJobLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/HandoverJobHandoverJobLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: HandoverJobHandoverJobLineItemsListFilter
      type: object
      description: HandoverJobHandoverJobLineItemsListFilter
    HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by title
      title: HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter
      type: object
      description: HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter
    HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: >-
                #/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsArticleFilter
          description: Nested search by article
      title: HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter
      type: object
      description: HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter
    HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/HandoverJobHandoverJobLineItemsSubstituteLineItemsFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter
      type: object
      description: HandoverJobHandoverJobLineItemsSubstituteLineItemsListFilter
    HandoverJobHandoverJobParcelInfoFilter:
      properties:
        carrierKey:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierKey
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        carrierTrackingNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierTrackingNumber
        shipmentRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shipmentRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: HandoverJobHandoverJobParcelInfoFilter
      type: object
      description: HandoverJobHandoverJobParcelInfoFilter
    HandoverJobHandoverjobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - HANDED_OVER
            - OBSOLETE
            - CANCELED
            - WAITING_FOR_INPUT
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - HANDED_OVER
              - OBSOLETE
              - CANCELED
              - WAITING_FOR_INPUT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - HANDED_OVER
            - OBSOLETE
            - CANCELED
            - WAITING_FOR_INPUT
          type: string
      title: HandoverJobHandoverjobStatusEnumFilter
      type: object
      description: HandoverJobHandoverjobStatusEnumFilter
    HandoverJobInvoiceAddressFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: HandoverJobInvoiceAddressFilter
      type: object
      description: HandoverJobInvoiceAddressFilter
    HandoverJobLineItemUpdateActionEnum:
      enum:
        - UPDATE_LINEITEM
      type: string
      title: HandoverJobLineItemUpdateActionEnum
      description: HandoverJobLineItemUpdateActionEnum
    HandoverJobLineItemUpdateActionParameter:
      additionalProperties: false
      description: Action to update a lineItem of a handoverjob.
      properties:
        lineItem:
          additionalProperties: false
          properties:
            id:
              type: string
            refused:
              items:
                $ref: '#/components/schemas/RefusedItemForUpdate'
              type: array
            status:
              $ref: '#/components/schemas/HandoverLineItemStatus'
            substituteItems:
              items:
                $ref: '#/components/schemas/HandoverSubstituteLineItemForUpdate'
              type: array
          required:
            - id
        name:
          $ref: '#/components/schemas/HandoverJobLineItemUpdateActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - lineItem
      title: HandoverJobLineItemUpdateActionParameter
    HandoverJobLogCancellationPayload:
      allOf:
        - $ref: '#/components/schemas/OperativeEntityPayloadBase'
      properties:
        cancelReason:
          $ref: '#/components/schemas/HandoverJobCancelReason'
      type: object
      title: HandoverJobLogCancellationPayload
      description: HandoverJobLogCancellationPayload
    HandoverJobOrderBy:
      description: STATUS_TARGET_TIME_LAST_MODIFIED_DATE is deprecated
      enum:
        - STATUS_TARGET_TIME_LAST_MODIFIED_DATE
        - TARGET_TIME_ASC
      title: HandoverJobOrderBy
    HandoverJobPaginatedResult:
      properties:
        handoverJobs:
          items:
            $ref: '#/components/schemas/Handoverjob'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - handoverJobs
      title: HandoverJobPaginatedResult
      type: object
      description: HandoverJobPaginatedResult
    HandoverJobParcelInfo:
      allOf:
        - $ref: '#/components/schemas/HandoverJobParcelInfoForCreation'
        - properties:
            carrierKey:
              description: the key of the carrier
              example: DHL
              type: string
      type: object
      title: HandoverJobParcelInfo
      description: HandoverJobParcelInfo
    HandoverJobParcelInfoForCreation:
      additionalProperties: false
      properties:
        carrierLogoUrl:
          description: The URL to the carrier logo
          example: https://www.example.com/carrierlogo.png
          type: string
        carrierParcelRef:
          description: The reference number of the parcel by the carrier
          example: '84168117830018'
          maxLength: 120
          minLength: 1
          type: string
        carrierRef:
          description: the reference to the related carrier
          example: 9ddb3c80-30ec-42c3-a750-9612296402ca
          type: string
        carrierTrackingNumber:
          description: the tracking number of the parcel
          example: '84168117830018'
          type: string
        parcelRef:
          description: the reference to the related parcel
          example: 9ddb3c80-30ec-42c3-a750-9612296402ca
          type: string
        shipmentRef:
          description: the reference to the related shipment
          example: 9ddb3c80-30ec-42c3-a750-9612296402ca
          type: string
      type: object
      title: HandoverJobParcelInfoForCreation
      description: HandoverJobParcelInfoForCreation
    HandoverjobPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyHandoverjob'
              - $ref: '#/components/schemas/CancelHandoverjob'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: HandoverjobPatchActions
      title: HandoverjobPatchActions
      description: HandoverjobPatchActions
    HandoverJobRecipientAddressFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: HandoverJobRecipientAddressFilter
      type: object
      description: HandoverJobRecipientAddressFilter
    HandoverJobReplaceAssignedUsersActionEnum:
      enum:
        - REPLACE_ASSIGNED_USERS
      type: string
      title: HandoverJobReplaceAssignedUsersActionEnum
      description: HandoverJobReplaceAssignedUsersActionEnum
    HandoverJobReplaceAssignedUsersActionParameter:
      additionalProperties: false
      description: Action to replace the assigned users.
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          type: array
        name:
          $ref: '#/components/schemas/HandoverJobReplaceAssignedUsersActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - assignedUsers
      title: HandoverJobReplaceAssignedUsersActionParameter
    HandoverJobSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/HandoverJobSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/HandoverJobSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: HandoverJobSearchPayload
      type: object
      description: HandoverJobSearchPayload
    HandoverJobSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/HandoverJobSearchQuery'
          maxItems: 500
          type: array
        anonymized:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by anonymized
        assignedUsers:
          allOf:
            - $ref: '#/components/schemas/HandoverJobAssignedUsersListFilter'
          description: Nested list search by assignedUsers
        channel:
          allOf:
            - $ref: '#/components/schemas/HandoverJobChannelEnumEnumFilter'
          description: Search by channel
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        fullIdentifier:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by fullIdentifier
        handoverJobLineItems:
          allOf:
            - $ref: '#/components/schemas/HandoverJobHandoverJobLineItemsListFilter'
          description: Nested list search by handoverJobLineItems
        handoverJobParcelInfo:
          allOf:
            - $ref: '#/components/schemas/HandoverJobHandoverJobParcelInfoFilter'
          description: Nested search by handoverJobParcelInfo
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        invoiceAddress:
          allOf:
            - $ref: '#/components/schemas/HandoverJobInvoiceAddressFilter'
          description: Nested search by invoiceAddress
        or:
          items:
            $ref: '#/components/schemas/HandoverJobSearchQuery'
          maxItems: 500
          type: array
        pickJobRef:
          allOf:
            - $ref: '#/components/schemas/StringEqFilter'
          description: Search by pickJobRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        recipientAddress:
          allOf:
            - $ref: '#/components/schemas/HandoverJobRecipientAddressFilter'
          description: Nested search by recipientAddress
        shortIdentifier:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by shortIdentifier
        status:
          allOf:
            - $ref: '#/components/schemas/HandoverJobHandoverjobStatusEnumFilter'
          description: Search by status
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: HandoverJobSearchQuery
      type: object
      description: HandoverJobSearchQuery
    HandoverJobSort:
      properties:
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
      title: HandoverJobSort
      type: object
      description: HandoverJobSort
    HandoverJobSplitLineItemsActionEnum:
      enum:
        - SPLIT_LINES_HANDOVER_JOB
      type: string
      title: HandoverJobSplitLineItemsActionEnum
      description: HandoverJobSplitLineItemsActionEnum
    HandoverJobSplitLineItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/HandoverJobSplitLineItemsActionEnum'
        splitLineItemsInfo:
          items:
            $ref: '#/components/schemas/HandoverJobSplitLineItemsInfo'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - splitLineItemsInfo
      title: HandoverJobSplitLineItemsActionParameter
      type: object
      description: HandoverJobSplitLineItemsActionParameter
    HandoverJobSplitLineItemsInfo:
      additionalProperties: false
      properties:
        handedOverQuantity:
          description: The amount of articles that were handed over for this line item.
          example: 20
          format: int64
          minimum: 0
          type: integer
        lineItemId:
          description: references the id of the line item of a handover job
          type: string
        quantity:
          description: quantity of the specific item that has been ordered
          example: 21
          minimum: 1
          type: integer
      required:
        - lineItemId
        - quantity
        - handedOverQuantity
      type: object
      title: HandoverJobSplitLineItemsInfo
      description: HandoverJobSplitLineItemsInfo
    HandoverjobStatus:
      description: |
        Status of a Handover Job.
        - OPEN: Active and ready for processing (default initial state)
        - WAITING_FOR_INPUT: Waiting for line items to be populated
        - HANDED_OVER: Items have been handed over (completion state)
        - CANCELED: Handover job was canceled
        - OBSOLETE: No longer relevant (terminal state, cannot transition out)
      enum:
        - OPEN
        - HANDED_OVER
        - OBSOLETE
        - CANCELED
        - WAITING_FOR_INPUT
      type: string
      title: HandoverjobStatus
    HandoverJobTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagConfiguration'
      properties:
        stickerConfiguration:
          $ref: '#/components/schemas/StickerConfiguration'
      title: HandoverJobTagConfiguration
      description: HandoverJobTagConfiguration
    HandoverJobWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Handoverjob'
      required:
        - payload
      type: object
      title: HandoverJobWebHookEvent
      description: HandoverJobWebHookEvent
    HandoverLineItem:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
      properties:
        article:
          $ref: '#/components/schemas/HandoverLineItemArticle'
        handedOverQuantity:
          description: quantity of the specific item that has been handed over
          example: 20
          format: int64
          minimum: 0
          type: integer
        id:
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened. This can be used to restore the ‘pre-split’
            status.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          nullable: true
          type: string
        quantity:
          description: quantity of the specific item that has been provided for handover
          example: 21
          format: int64
          minimum: 1
          type: integer
        refused:
          items:
            $ref: '#/components/schemas/RefusedItem'
          type: array
        status:
          $ref: '#/components/schemas/HandoverLineItemStatus'
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        substituteLineItems:
          description: >-
            This part of the API is in Beta status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          items:
            $ref: '#/components/schemas/HandoverSubstituteLineItem'
          type: array
          x-badges:
            - color: orange
              label: BETA
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - id
        - article
        - quantity
        - handedOverQuantity
      title: HandoverLineItem
      description: HandoverLineItem
    HandoverLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              maxItems: 40
              type: array
          type: object
      xml:
        name: HandoverLineItemArticle
      title: HandoverLineItemArticle
      description: HandoverLineItemArticle
    HandoverLineItemForCreation:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItemForCreation'
      properties:
        article:
          $ref: '#/components/schemas/HandoverLineItemArticle'
        handedOverQuantity:
          description: quantity of the specific item that has been handed over
          example: 20
          format: int64
          minimum: 0
          type: integer
        quantity:
          description: quantity of the specific item that has been provided for handover
          example: 21
          format: int64
          minimum: 1
          type: integer
        refused:
          items:
            $ref: '#/components/schemas/RefusedItem'
          type: array
        status:
          $ref: '#/components/schemas/HandoverLineItemStatus'
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        substituteLineItems:
          description: >-
            This part of the API is in Beta status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          items:
            $ref: '#/components/schemas/HandoverSubstituteLineItemForCreation'
          type: array
          x-badges:
            - color: orange
              label: BETA
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - quantity
        - article
        - handedOverQuantity
      type: object
      title: HandoverLineItemForCreation
      description: HandoverLineItemForCreation
    HandoverLineItemStatus:
      enum:
        - OPEN
        - CLOSED
      type: string
      title: HandoverLineItemStatus
      description: HandoverLineItemStatus
    HandoverSubstituteLineItem:
      properties:
        article:
          $ref: '#/components/schemas/SubstituteLineItemArticle'
        handedOverQuantity:
          description: >-
            quantity of the specific item to substitute the original line item
            that has been handed over
          example: 20
          format: int64
          minimum: 0
          type: integer
        id:
          type: string
        partialStockLocations:
          items:
            $ref: '#/components/schemas/SubstituteLineItemPartialStockLocation'
          type: array
        pickedAt:
          description: Date when the line has been picked.
          example: 2024-02-03T08:45:51.525Z
          format: date-time
          type: string
        priority:
          description: >-
            This field allows you to rank substitutes against each other. The
            lowest number is the most preferrable substitute.
          minimum: 0
          type: number
        quantity:
          description: >-
            quantity of the specific item to substitute the original line item
            that has been provided for handover
          example: 21
          format: int64
          minimum: 1
          type: integer
        refused:
          items:
            $ref: '#/components/schemas/RefusedItem'
          type: array
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
      required:
        - quantity
        - article
        - id
      title: HandoverSubstituteLineItem
      description: HandoverSubstituteLineItem
    HandoverSubstituteLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/SubstituteLineItemArticle'
        handedOverQuantity:
          description: >-
            quantity of the specific item to substitute the original line item
            that has been handed over
          example: 20
          format: int64
          minimum: 0
          type: integer
        partialStockLocations:
          items:
            $ref: '#/components/schemas/SubstituteLineItemPartialStockLocation'
          type: array
        pickedAt:
          description: Date when the line has been picked.
          example: 2024-02-03T08:45:51.525Z
          format: date-time
          type: string
        priority:
          description: >-
            This field allows you to rank substitutes against each other. The
            lowest number is the most preferrable substitute.
          minimum: 0
          type: number
        quantity:
          description: >-
            quantity of the specific item to substitute the original line item
            that has been provided for handover
          example: 21
          format: int64
          minimum: 1
          type: integer
        refused:
          items:
            $ref: '#/components/schemas/RefusedItem'
          type: array
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
      required:
        - quantity
        - article
      title: HandoverSubstituteLineItemForCreation
      description: HandoverSubstituteLineItemForCreation
    HandoverSubstituteLineItemForUpdate:
      properties:
        id:
          type: string
        refused:
          items:
            $ref: '#/components/schemas/RefusedItemForUpdate'
          type: array
      required:
        - id
      title: HandoverSubstituteLineItemForUpdate
      description: HandoverSubstituteLineItemForUpdate
    HealthDependencyStatus:
      properties:
        name:
          description: Name of the component that is checked to be healthy
          example: database
          type: string
        status:
          $ref: '#/components/schemas/HealthStatus'
      required:
        - name
        - status
      type: object
      title: HealthDependencyStatus
      description: HealthDependencyStatus
    HealthResult:
      properties:
        dependencies:
          items:
            $ref: '#/components/schemas/HealthDependencyStatus'
          minItems: 1
          type: array
        status:
          $ref: '#/components/schemas/HealthStatus'
      required:
        - status
        - dependencies
      type: object
      title: HealthResult
      description: HealthResult
    HealthStatus:
      enum:
        - UP
        - DOWN
      type: string
      title: HealthStatus
      description: HealthStatus
    InboundAttachment:
      properties:
        created:
          format: date-time
          type: string
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        version:
          type: number
      required:
        - id
        - version
      title: InboundAttachment
      type: object
      description: InboundAttachment
    InboundAttachmentForCreation:
      properties:
        content:
          description: Base64 encoded attachment file
          type: string
        fileName:
          description: File name of attachment
          type: string
      required:
        - fileName
        - content
      title: InboundAttachmentForCreation
      type: object
      description: InboundAttachmentForCreation
    InboundAttachmentLink:
      properties:
        inboundAttachmentRef:
          type: string
      required:
        - inboundAttachmentRef
      title: InboundAttachmentLink
      type: object
      description: InboundAttachmentLink
    InboundDeliveryFinishedPayload:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        inboundProcessRef:
          type: string
        onHold:
          type: boolean
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        receipts:
          items:
            $ref: '#/components/schemas/InboundReceipt'
          type: array
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessRef:
          type: string
      required:
        - inboundProcessRef
        - facilityRef
        - status
        - onHold
        - receipts
      title: InboundDeliveryFinishedPayload
      type: object
      description: InboundDeliveryFinishedPayload
    InboundDeliveryFinishedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/InboundDeliveryFinishedPayload'
      required:
        - payload
      type: object
      title: InboundDeliveryFinishedWebHookEvent
      description: InboundDeliveryFinishedWebHookEvent
    InboundDeliveryOnHoldPayload:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        inboundProcessRef:
          type: string
        onHold:
          type: boolean
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessRef:
          type: string
      required:
        - inboundProcessRef
        - facilityRef
        - status
        - onHold
      title: InboundDeliveryOnHoldPayload
      type: object
      description: InboundDeliveryOnHoldPayload
    InboundDeliveryOnHoldWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/InboundDeliveryOnHoldPayload'
      required:
        - payload
      type: object
      title: InboundDeliveryOnHoldWebHookEvent
      description: InboundDeliveryOnHoldWebHookEvent
    InboundDeliveryReceivedPayload:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        inboundProcessRef:
          type: string
        onHold:
          type: boolean
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        receipt:
          $ref: '#/components/schemas/InboundReceipt'
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessRef:
          type: string
      required:
        - inboundProcessRef
        - facilityRef
        - status
        - onHold
        - receipt
      title: InboundDeliveryReceivedPayload
      type: object
      description: InboundDeliveryReceivedPayload
    InboundDeliveryReceivedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/InboundDeliveryReceivedPayload'
      required:
        - payload
      type: object
      title: InboundDeliveryReceivedWebHookEvent
      description: InboundDeliveryReceivedWebHookEvent
    InboundDeliveryReleasedPayload:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        inboundProcessRef:
          type: string
        onHold:
          type: boolean
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessRef:
          type: string
      required:
        - inboundProcessRef
        - facilityRef
        - status
        - onHold
      title: InboundDeliveryReleasedPayload
      type: object
      description: InboundDeliveryReleasedPayload
    InboundDeliveryReleasedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/InboundDeliveryReleasedPayload'
      required:
        - payload
      type: object
      title: InboundDeliveryReleasedWebHookEvent
      description: InboundDeliveryReleasedWebHookEvent
    InboundDeliverySingleReceiptPayload:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        inboundProcessRef:
          type: string
        onHold:
          type: boolean
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        receipt:
          $ref: '#/components/schemas/InboundReceipt'
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessRef:
          type: string
      required:
        - inboundProcessRef
        - facilityRef
        - status
        - onHold
        - receipt
      title: InboundDeliverySingleReceiptPayload
      type: object
      description: InboundDeliverySingleReceiptPayload
    InboundLineItem:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        quantity:
          $ref: '#/components/schemas/Quantity'
        stockProperties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - quantity
      title: InboundLineItem
      type: object
      description: InboundLineItem
    InboundProcess:
      properties:
        anonymized:
          description: >-
            Indicates the inbound process was anonymized acording to configured
            GDPR retention time.
          type: boolean
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        id:
          type: string
        inboundDate:
          description: >-
            Aggregated dates from sources which advise incoming stock. Currently
            that is "purchaseOrder"
          example: 2026-06-17T12:00:00.000Z
          items:
            format: date-time
            type: string
          type: array
        lastModified:
          format: date-time
          type: string
        onHold:
          description: >-
            Indicates if the inbound process is on hold and will not be
            processed further
          type: boolean
        origin:
          description: >-
            Aggregated origin data from sources which advise incoming stock.
            Currently that is just  "purchaseOrder"
          items:
            $ref: '#/components/schemas/InboundProcessOrigin'
          type: array
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        receipts:
          items:
            $ref: '#/components/schemas/InboundReceipt'
          type: array
        scannableCodes:
          description: >-
            scannableCodes such as barcodes that are relevant in the
            inboundProcess, e.g. , barcode of the delivery note
          items:
            type: string
          type: array
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessId:
          type: string
        version:
          type: number
      required:
        - facilityRef
        - id
        - version
        - created
        - lastModified
        - inboundDate
        - origin
        - anonymized
        - status
        - onHold
        - scannableCodes
        - receipts
      title: InboundProcess
      type: object
      description: InboundProcess
    InboundProcessForCreation:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: Facility in which the inbound process takes place
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        onHold:
          description: >-
            Indicates if the inbound process is on hold and will not be
            processed further
          type: boolean
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderForCreation'
        receipts:
          items:
            $ref: '#/components/schemas/InboundReceiptForCreation'
          maxItems: 200
          type: array
        scannableCodes:
          description: >-
            scannableCodes such as barcodes that are relevant in the
            inboundProcess, e.g. , barcode of the delivery note
          items:
            type: string
          type: array
        tenantInboundProcessId:
          description: >-
            Identifier of the process provided by the tenant system. It is
            recommended to be unique
          example: MY_INBOUNDPROCESS_ID
          type: string
      required:
        - facilityRef
      title: InboundProcessForCreation
      type: object
      description: InboundProcessForCreation
    InboundProcessForPatch:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        onHold:
          description: >-
            Indicates if the inbound process is on hold and will not be
            processed further
          type: boolean
        scannableCodes:
          description: >-
            scannableCodes such as barcodes that are relevant in the
            inboundProcess, e.g. , barcode of the delivery note
          items:
            type: string
          type: array
        version:
          type: number
      required:
        - version
      title: InboundProcessForPatch
      type: object
      description: InboundProcessForPatch
    InboundProcessOrigin:
      properties:
        name:
          type: string
      title: InboundProcessOrigin
      type: object
      description: InboundProcessOrigin
    InboundProcessPaginatedResult:
      properties:
        inboundProcesses:
          items:
            $ref: '#/components/schemas/InboundProcess'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - inboundProcesses
      title: InboundProcessPaginatedResult
      type: object
      description: InboundProcessPaginatedResult
    InboundProcessPurchaseOrder:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        orderDate:
          description: >-
            Time and date at which the order was placed. Note: This does not
            refer to the creation date of this entity in the system.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/RequestedDate'
          description: >-
            Time and date at which the order is expected to arrive. Use 'ASAP'
            for deliveries with unknown date, but be aware that some features
            will not include these orders.
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          description: Line items which are expected to be delivered.
          items:
            $ref: '#/components/schemas/InboundLineItem'
          maxItems: 200
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
        transfer:
          allOf:
            - $ref: '#/components/schemas/InboundProcessPurchaseOrderTransfer'
          description: >-
            Includes data about transfer between different facilities in the
            tenant's network.
      required:
        - orderDate
        - requestedDate
        - requestedItems
        - status
        - cancelled
        - id
        - created
        - lastModified
      title: InboundProcessPurchaseOrder
      type: object
      description: InboundProcessPurchaseOrder
    InboundProcessPurchaseOrderFilter:
      properties:
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        orderDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by orderDate. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
          example: 2026-06-17T12:00:00.000Z
        requestedDate:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessPurchaseOrderRequestedDateFilter
          description: Nested search by requestedDate
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessPurchaseOrderRequestedItemsListFilter
          description: Nested list search by requestedItems
        status:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter
          description: Search by status
        supplier:
          allOf:
            - $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplierFilter'
          description: Nested search by supplier
        transfer:
          allOf:
            - $ref: '#/components/schemas/InboundProcessPurchaseOrderTransferFilter'
          description: Nested search by transfer
      title: InboundProcessPurchaseOrderFilter
      type: object
      description: InboundProcessPurchaseOrderFilter
    InboundProcessPurchaseOrderForCreation:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        orderDate:
          description: >-
            Time and date at which the order was placed. Note: This does not
            refer to the creation date of this entity in the system.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/InputRequestedDate'
          description: >-
            Time and date at which the order is expected to arrive. Use 'ASAP'
            for deliveries with unknown date, but be aware that some features
            will not include these orders.
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          description: Line items which are expected to be delivered.
          items:
            $ref: '#/components/schemas/InboundLineItem'
          maxItems: 200
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
      required:
        - orderDate
        - requestedDate
        - requestedItems
      title: InboundProcessPurchaseOrderForCreation
      type: object
      description: InboundProcessPurchaseOrderForCreation
    InboundProcessPurchaseOrderForUpsert:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        orderDate:
          description: >-
            Time and date at which the order was placed. Note: This does not
            refer to the creation date of this entity in the system.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/InputRequestedDate'
          description: >-
            Time and date at which the order is expected to arrive. Use 'ASAP'
            for deliveries with unknown date, but be aware that some features
            will not include these orders.
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          description: Line items which are expected to be delivered.
          items:
            $ref: '#/components/schemas/InboundLineItem'
          maxItems: 200
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
        version:
          type: number
      required:
        - orderDate
        - requestedDate
        - requestedItems
        - version
      title: InboundProcessPurchaseOrderForUpsert
      type: object
      description: InboundProcessPurchaseOrderForUpsert
    InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - CANCELED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - CANCELED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - CANCELED
          type: string
      title: InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter
      type: object
      description: InboundProcessPurchaseOrderPurchaseOrderStatusEnumEnumFilter
    InboundProcessPurchaseOrderRequestedDateFilter:
      properties:
        type:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter
          description: Search by type
        value:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by value
      title: InboundProcessPurchaseOrderRequestedDateFilter
      type: object
      description: InboundProcessPurchaseOrderRequestedDateFilter
    InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - ASAP
            - TIME_POINT
          type: string
        in:
          description: Search by type
          items:
            enum:
              - ASAP
              - TIME_POINT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - ASAP
            - TIME_POINT
          type: string
      title: InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter
      type: object
      description: InboundProcessPurchaseOrderRequestedDateRequestedDateTypeEnumFilter
    InboundProcessPurchaseOrderRequestedItemsFilter:
      properties:
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        stockProperties:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/StringFilter'
              - $ref: '#/components/schemas/KeyExistsFilter'
          description: Search by stockProperties
          type: object
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
      title: InboundProcessPurchaseOrderRequestedItemsFilter
      type: object
      description: InboundProcessPurchaseOrderRequestedItemsFilter
    InboundProcessPurchaseOrderRequestedItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessPurchaseOrderRequestedItemsFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: InboundProcessPurchaseOrderRequestedItemsListFilter
      type: object
      description: InboundProcessPurchaseOrderRequestedItemsListFilter
    InboundProcessPurchaseOrderSort:
      properties:
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/InboundProcessRequestedDateSort'
          example: 2026-06-17T12:00:00.000Z
        supplier:
          $ref: '#/components/schemas/InboundProcessSupplierSort'
      title: InboundProcessPurchaseOrderSort
      type: object
      description: InboundProcessPurchaseOrderSort
    InboundProcessPurchaseOrderSupplier:
      properties:
        name:
          description: Name of the supplier.
          type: string
      title: InboundProcessPurchaseOrderSupplier
      type: object
      description: InboundProcessPurchaseOrderSupplier
    InboundProcessPurchaseOrderSupplierFilter:
      properties:
        name:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by name
      title: InboundProcessPurchaseOrderSupplierFilter
      type: object
      description: InboundProcessPurchaseOrderSupplierFilter
    InboundProcessPurchaseOrderTransfer:
      properties:
        id:
          type: string
      required:
        - id
      title: InboundProcessPurchaseOrderTransfer
      type: object
      description: InboundProcessPurchaseOrderTransfer
    InboundProcessPurchaseOrderTransferFilter:
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: InboundProcessPurchaseOrderTransferFilter
      type: object
      description: InboundProcessPurchaseOrderTransferFilter
    InboundProcessReceiptBulkWebHookEvent:
      properties:
        payload:
          $ref: '#/components/schemas/InboundProcessReceiptBulkWebHookEventPayload'
      required:
        - payload
      title: InboundProcessReceiptBulkWebHookEvent
      type: object
      description: InboundProcessReceiptBulkWebHookEvent
    InboundProcessReceiptBulkWebHookEventPayload:
      properties:
        items:
          items:
            $ref: '#/components/schemas/InboundDeliverySingleReceiptPayload'
          type: array
      required:
        - items
      title: InboundProcessReceiptBulkWebHookEventPayload
      type: object
      description: InboundProcessReceiptBulkWebHookEventPayload
    InboundProcessReceiptsFilter:
      properties:
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        receivedDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by receivedDate
          example: 2026-06-17T12:00:00.000Z
        receivedItems:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessReceiptsReceivedItemsListFilter
          description: Nested list search by receivedItems
        status:
          allOf:
            - $ref: >-
                #/components/schemas/InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter
          description: Search by status
      title: InboundProcessReceiptsFilter
      type: object
      description: InboundProcessReceiptsFilter
    InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - IN_PROGRESS
              - FINISHED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
      title: InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter
      type: object
      description: InboundProcessReceiptsInboundReceiptStatusTypeEnumFilter
    InboundProcessReceiptsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/InboundProcessReceiptsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: InboundProcessReceiptsListFilter
      type: object
      description: InboundProcessReceiptsListFilter
    InboundProcessReceiptsReceivedItemsFilter:
      properties:
        stockProperties:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/StringFilter'
              - $ref: '#/components/schemas/KeyExistsFilter'
          description: Search by stockProperties
          type: object
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
      title: InboundProcessReceiptsReceivedItemsFilter
      type: object
      description: InboundProcessReceiptsReceivedItemsFilter
    InboundProcessReceiptsReceivedItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/InboundProcessReceiptsReceivedItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: InboundProcessReceiptsReceivedItemsListFilter
      type: object
      description: InboundProcessReceiptsReceivedItemsListFilter
    InboundProcessRequestedDateSort:
      properties:
        type:
          enum:
            - ASC
            - DESC
          type: string
        value:
          enum:
            - ASC
            - DESC
          type: string
      title: InboundProcessRequestedDateSort
      type: object
      description: InboundProcessRequestedDateSort
    InboundProcessSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/InboundProcessSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/InboundProcessSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: InboundProcessSearchPayload
      type: object
      description: InboundProcessSearchPayload
    InboundProcessSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/InboundProcessSearchQuery'
          maxItems: 500
          type: array
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        inboundDate:
          allOf:
            - $ref: '#/components/schemas/DateListFilter'
          description: Search by inboundDate
          example: 2026-06-17T12:00:00.000Z
        or:
          items:
            $ref: '#/components/schemas/InboundProcessSearchQuery'
          maxItems: 500
          type: array
        purchaseOrder:
          allOf:
            - $ref: '#/components/schemas/InboundProcessPurchaseOrderFilter'
          description: Nested search by purchaseOrder
        receipts:
          allOf:
            - $ref: '#/components/schemas/InboundProcessReceiptsListFilter'
          description: Nested list search by receipts
        scannableCodes:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by scannableCodes
        status:
          allOf:
            - $ref: '#/components/schemas/InboundProcessStatusTypeEnumFilter'
          description: Search by status
        tenantInboundProcessId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantInboundProcessId
          example: MY_INBOUNDPROCESS_ID
      title: InboundProcessSearchQuery
      type: object
      description: InboundProcessSearchQuery
    InboundProcessSort:
      properties:
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        po_created:
          enum:
            - ASC
            - DESC
          type: string
        purchaseOrder:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSort'
      title: InboundProcessSort
      type: object
      description: InboundProcessSort
    InboundProcessStatusTypeEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - PARTIAL_DELIVERY
              - ON_HOLD
              - CLOSED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
      title: InboundProcessStatusTypeEnumFilter
      type: object
      description: InboundProcessStatusTypeEnumFilter
    InboundProcessSupplierSort:
      properties:
        name:
          enum:
            - ASC
            - DESC
          type: string
      title: InboundProcessSupplierSort
      type: object
      description: InboundProcessSupplierSort
    InboundReceipt:
      properties:
        asnRef:
          description: enables mapping a receipt to one of the ASNs in this inbound process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptComment'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        receivedDate:
          description: date-time of the arrival of the items in the facility
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        receivedItems:
          description: list of item that arrived in the facility
          items:
            $ref: '#/components/schemas/InboundReceiptLineItem'
          maxItems: 200
          type: array
        status:
          description: >-
            status of this receipt, only receipts with status 'FINISHED' are
            booked. IN_PROGRESS can be used to save partial receipts.
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
      required:
        - receivedDate
        - receivedItems
        - comments
        - id
      title: InboundReceipt
      type: object
      description: InboundReceipt
    InboundReceiptComment:
      properties:
        attachments:
          deprecated: true
          description: attachments such as photos or documents
          items:
            $ref: '#/components/schemas/InboundAttachmentLink'
          type: array
        content:
          description: text content of the comment
          type: string
        documentSetRef:
          description: >-
            reference to the documentSet that contains the attachments.
            Read-only field
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          type: string
        userRef:
          description: >-
            user that added the comment, is anonymized according to specified
            rules
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - content
      title: InboundReceiptComment
      type: object
      description: InboundReceiptComment
    InboundReceiptCommentForCreation:
      properties:
        attachments:
          deprecated: true
          description: attachments such as photos or documents
          items:
            $ref: '#/components/schemas/InboundAttachmentLink'
          type: array
        content:
          description: text content of the comment
          type: string
        userRef:
          description: >-
            user that added the comment, is anonymized according to specified
            rules
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - content
      title: InboundReceiptCommentForCreation
      type: object
      description: InboundReceiptCommentForCreation
    InboundReceiptCommentForUpdate:
      properties:
        attachments:
          deprecated: true
          description: attachments such as photos or documents
          items:
            $ref: '#/components/schemas/InboundAttachmentLink'
          type: array
        content:
          description: text content of the comment
          type: string
        id:
          type: string
        userRef:
          description: >-
            user that added the comment, is anonymized according to specified
            rules
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - content
      title: InboundReceiptCommentForUpdate
      type: object
      description: InboundReceiptCommentForUpdate
    InboundReceiptForCreation:
      properties:
        asnRef:
          description: enables mapping a receipt to one of the ASNs in this inbound process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptCommentForCreation'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        receivedDate:
          description: date-time of the arrival of the items in the facility
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        receivedItems:
          description: list of item that arrived in the facility
          items:
            $ref: '#/components/schemas/InboundReceiptLineItemForCreation'
          maxItems: 200
          type: array
        status:
          description: >-
            status of this receipt, only receipts with status 'FINISHED' are
            booked. IN_PROGRESS can be used to save partial receipts.
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
      required:
        - receivedDate
        - receivedItems
        - comments
      title: InboundReceiptForCreation
      type: object
      description: InboundReceiptForCreation
    InboundReceiptForPatch:
      properties:
        asnRef:
          description: enables mapping a receipt to one of the ASNs in this inbound process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptCommentForUpdate'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        receivedDate:
          description: date-time of the arrival of the items in the facility
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        receivedItems:
          description: list of item that arrived in the facility
          items:
            $ref: '#/components/schemas/InboundReceiptLineItemForUpdate'
          maxItems: 200
          type: array
        status:
          description: >-
            status of this receipt, only receipts with status 'FINISHED' are
            booked. IN_PROGRESS can be used to save partial receipts.
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
        version:
          type: number
      required:
        - version
      title: InboundReceiptForPatch
      type: object
      description: InboundReceiptForPatch
    InboundReceiptForUpdate:
      properties:
        asnRef:
          description: enables mapping a receipt to one of the ASNs in this inbound process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptCommentForUpdate'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        receivedDate:
          description: date-time of the arrival of the items in the facility
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        receivedItems:
          description: list of item that arrived in the facility
          items:
            $ref: '#/components/schemas/InboundReceiptLineItemForUpdate'
          maxItems: 200
          type: array
        status:
          description: >-
            status of this receipt, only receipts with status 'FINISHED' are
            booked. IN_PROGRESS can be used to save partial receipts.
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
        version:
          type: number
      required:
        - receivedDate
        - receivedItems
        - comments
        - version
      title: InboundReceiptForUpdate
      type: object
      description: InboundReceiptForUpdate
    InboundReceiptJob:
      properties:
        expectedDate:
          $ref: '#/components/schemas/RequestedDate'
        facilityRef:
          type: string
        id:
          type: string
        inboundProcessRef:
          type: string
        items:
          $ref: '#/components/schemas/InboundLineItem'
        origin:
          $ref: '#/components/schemas/InboundReceiptJobOrigin'
        originReadableId:
          type: string
        originReadableName:
          type: string
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
      required:
        - id
        - facilityRef
        - inboundProcessRef
        - status
        - expectedDate
        - items
        - origin
      title: InboundReceiptJob
      type: object
      description: InboundReceiptJob
    InboundReceiptJobOrigin:
      properties:
        name:
          type: string
      title: InboundReceiptJobOrigin
      type: object
      description: InboundReceiptJobOrigin
    InboundReceiptJobPaginatedResult:
      properties:
        inboundReceiptJobs:
          items:
            $ref: '#/components/schemas/InboundReceiptJob'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - inboundReceiptJobs
      title: InboundReceiptJobPaginatedResult
      type: object
      description: InboundReceiptJobPaginatedResult
    InboundReceiptLineItem:
      properties:
        acceptedQuantity:
          allOf:
            - $ref: '#/components/schemas/Quantity'
          description: >-
            quantity of the stock that was accepted in this receipt. If its
            larger than 0, Stock will be created when this receipt is FINISHED.
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptComment'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        rejectedQuantity:
          allOf:
            - $ref: '#/components/schemas/Quantity'
          description: >-
            quantity of the stock that was rejected in this receipt. If it is
            larger than 0, Stock will be created with condition "defective" when
            this receipt is FINISHED.
        stockProperties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
          description: stock properties that will be set on the created stock
        storageLocationRef:
          description: storage location on which stock was placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock that was received
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
        - acceptedQuantity
        - rejectedQuantity
        - comments
      title: InboundReceiptLineItem
      type: object
      description: InboundReceiptLineItem
    InboundReceiptLineItemForCreation:
      properties:
        acceptedQuantity:
          allOf:
            - $ref: '#/components/schemas/Quantity'
          description: >-
            quantity of the stock that was accepted in this receipt. If its
            larger than 0, Stock will be created when this receipt is FINISHED.
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptCommentForCreation'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        rejectedQuantity:
          allOf:
            - $ref: '#/components/schemas/Quantity'
          description: >-
            quantity of the stock that was rejected in this receipt. If it is
            larger than 0, Stock will be created with condition "defective" when
            this receipt is FINISHED.
        stockProperties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
          description: stock properties that will be set on the created stock
        storageLocationRef:
          description: storage location on which stock was placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock that was received
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
        - acceptedQuantity
        - rejectedQuantity
        - comments
      title: InboundReceiptLineItemForCreation
      type: object
      description: InboundReceiptLineItemForCreation
    InboundReceiptLineItemForUpdate:
      properties:
        acceptedQuantity:
          allOf:
            - $ref: '#/components/schemas/Quantity'
          description: >-
            quantity of the stock that was accepted in this receipt. If its
            larger than 0, Stock will be created when this receipt is FINISHED.
        comments:
          description: comments regarding the receival of this item
          items:
            $ref: '#/components/schemas/InboundReceiptCommentForUpdate'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        rejectedQuantity:
          allOf:
            - $ref: '#/components/schemas/Quantity'
          description: >-
            quantity of the stock that was rejected in this receipt. If it is
            larger than 0, Stock will be created with condition "defective" when
            this receipt is FINISHED.
        stockProperties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
          description: stock properties that will be set on the created stock
        storageLocationRef:
          description: storage location on which stock was placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock that was received
          example: MY_ARTICLE_ID
          type: string
      required:
        - tenantArticleId
        - acceptedQuantity
        - rejectedQuantity
        - comments
      title: InboundReceiptLineItemForUpdate
      type: object
      description: InboundReceiptLineItemForUpdate
    InheritedDocumentConfiguration:
      properties:
        section:
          $ref: '#/components/schemas/Section'
      required:
        - section
      title: InheritedDocumentConfiguration
      description: InheritedDocumentConfiguration
    InheritedServiceJobLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceJobLineItemArticle'
          description: Article information of this inherited line item
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: Unique ID of this inherited line item
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: Quantity of the items
          example: 12
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
        serviceJobRef:
          description: Reference to the service job this line item was inherited from
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
      required:
        - id
        - article
        - quantity
        - serviceJobRef
      title: InheritedServiceJobLineItem
      type: object
      description: InheritedServiceJobLineItem
    InputRequestedDate:
      properties:
        type:
          enum:
            - ASAP
            - TIME_POINT
          type: string
        value:
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      required:
        - type
      title: InputRequestedDate
      type: object
      description: InputRequestedDate
    IntegerValidation:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/BaseValidation'
      description: Validate input as integer.
      properties:
        maxValue:
          type: number
        minValue:
          type: number
      title: IntegerValidation
      type: object
    InterFacilityConnection:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        id:
          type: string
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        sourceFacilityRef:
          type: string
        target:
          oneOf:
            - $ref: '#/components/schemas/InterFacilityConnectionCustomerTarget'
            - $ref: >-
                #/components/schemas/InterFacilityConnectionManagedFacilityTarget
            - $ref: '#/components/schemas/InterFacilityConnectionSupplierTarget'
          discriminator:
            propertyName: type
            mapping:
              CUSTOMER: '#/components/schemas/InterFacilityConnectionCustomerTarget'
              MANAGED_FACILITY: >-
                #/components/schemas/InterFacilityConnectionManagedFacilityTarget
              SUPPLIER: '#/components/schemas/InterFacilityConnectionSupplierTarget'
      required:
        - id
        - sourceFacilityRef
        - target
      type: object
      xml:
        name: InterFacilityConnection
      title: InterFacilityConnection
      description: InterFacilityConnection
    InterFacilityConnectionBaseTarget:
      discriminator:
        propertyName: type
      properties:
        type:
          $ref: '#/components/schemas/ConnectionType'
      required:
        - type
      type: object
      xml:
        name: InterFacilityConnectionBaseTarget
      title: InterFacilityConnectionBaseTarget
      description: InterFacilityConnectionBaseTarget
    InterFacilityConnectionContext:
      additionalProperties: false
      properties:
        operator:
          $ref: '#/components/schemas/ContextOperator'
        type:
          $ref: '#/components/schemas/InterFacilityConnectionContextTypes'
        values:
          items:
            maxItems: 2000
            minItems: 0
            type: string
          type: array
      required:
        - type
        - values
      type: object
      title: InterFacilityConnectionContext
      description: InterFacilityConnectionContext
    InterFacilityConnectionContextTypes:
      enum:
        - FACILITY
        - FACILITY_GROUP
        - CATEGORY
        - TAG_REFERENCE
      type: string
      title: InterFacilityConnectionContextTypes
      description: InterFacilityConnectionContextTypes
    InterFacilityConnectionCustomerTarget:
      allOf:
        - $ref: '#/components/schemas/InterFacilityConnectionBaseTarget'
      type: object
      title: InterFacilityConnectionCustomerTarget
      description: InterFacilityConnectionCustomerTarget
    InterFacilityConnectionDeliveryCost:
      additionalProperties: false
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          minimum: 0
          type: integer
        deliveryCostCoefficient:
          $ref: '#/components/schemas/DeliverCostCoefficient'
        value:
          description: >-
            Value of operational cost of the facility. Value is configured in
            the smallest subunit, e.g. cents.
          example: 25000
          minimum: 0
          type: integer
      required:
        - value
        - currency
      type: object
      title: InterFacilityConnectionDeliveryCost
      description: InterFacilityConnectionDeliveryCost
    InterFacilityConnectionFallbackCost:
      additionalProperties: false
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          minimum: 0
          type: integer
        value:
          description: >-
            Value of operational cost of the facility. Value is configured in
            the smallest subunit, e.g. cents.
          example: 25000
          minimum: 0
          type: integer
      required:
        - value
        - currency
      type: object
      title: InterFacilityConnectionFallbackCost
      description: InterFacilityConnectionFallbackCost
    InterFacilityConnectionForCreation:
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        type:
          $ref: '#/components/schemas/ConnectionType'
      required:
        - type
      type: object
      xml:
        name: InterFacilityConnectionForCreation
      title: InterFacilityConnectionForCreation
      description: InterFacilityConnectionForCreation
    InterFacilityConnectionForUpdate:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        type:
          $ref: '#/components/schemas/ConnectionType'
        version:
          type: number
      required:
        - version
        - type
      type: object
      xml:
        name: InterFacilityConnectionForUpdate
      title: InterFacilityConnectionForUpdate
      description: InterFacilityConnectionForUpdate
    InterFacilityConnectionManagedFacilityTarget:
      allOf:
        - $ref: '#/components/schemas/InterFacilityConnectionBaseTarget'
      properties:
        excludedFacilityGroupRefs:
          items:
            type: string
          type: array
        excludedFacilityRefs:
          items:
            type: string
          type: array
        facilityRef:
          type: string
      type: object
      title: InterFacilityConnectionManagedFacilityTarget
      description: InterFacilityConnectionManagedFacilityTarget
    InterFacilityConnections:
      additionalProperties: false
      properties:
        interFacilityConnections:
          items:
            $ref: '#/components/schemas/InterFacilityConnection'
          type: array
        total:
          description: Total number of entities found for this query
          example: 42
          type: integer
      required:
        - interFacilityConnections
        - total
      type: object
      xml:
        name: InterFacilityConnection
      title: InterFacilityConnections
      description: InterFacilityConnections
    InterFacilityConnectionSupplierTarget:
      allOf:
        - $ref: '#/components/schemas/InterFacilityConnectionBaseTarget'
      properties:
        excludedFacilityGroupRefs:
          items:
            type: string
          type: array
        excludedFacilityRefs:
          items:
            type: string
          type: array
        facilityRef:
          type: string
      type: object
      title: InterFacilityConnectionSupplierTarget
      description: InterFacilityConnectionSupplierTarget
    InterFacilityConnectionToCustomerForCreation:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        target:
          $ref: '#/components/schemas/InterFacilityConnectionCustomerTarget'
        type:
          $ref: '#/components/schemas/ConnectionType'
      required:
        - target
        - type
      type: object
      xml:
        name: InterFacilityConnectionToCustomerForCreation
      title: InterFacilityConnectionToCustomerForCreation
      description: InterFacilityConnectionToCustomerForCreation
    InterFacilityConnectionToCustomerForUpdate:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        target:
          $ref: '#/components/schemas/InterFacilityConnectionCustomerTarget'
        type:
          $ref: '#/components/schemas/ConnectionType'
        version:
          type: number
      required:
        - target
        - version
        - type
      type: object
      xml:
        name: InterFacilityConnectionToCustomerForUpdate
      title: InterFacilityConnectionToCustomerForUpdate
      description: InterFacilityConnectionToCustomerForUpdate
    InterFacilityConnectionToManagedFacilityForCreation:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        target:
          $ref: '#/components/schemas/InterFacilityConnectionManagedFacilityTarget'
        type:
          $ref: '#/components/schemas/ConnectionType'
      required:
        - target
        - type
      type: object
      xml:
        name: InterFacilityConnectionToManagedFacilityForCreation
      title: InterFacilityConnectionToManagedFacilityForCreation
      description: InterFacilityConnectionToManagedFacilityForCreation
    InterFacilityConnectionToManagedFacilityForUpdate:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        target:
          $ref: '#/components/schemas/InterFacilityConnectionManagedFacilityTarget'
        type:
          $ref: '#/components/schemas/ConnectionType'
        version:
          type: number
      required:
        - target
        - version
        - type
      type: object
      xml:
        name: InterFacilityConnectionToManagedFacilityForUpdate
      title: InterFacilityConnectionToManagedFacilityForUpdate
      description: InterFacilityConnectionToManagedFacilityForUpdate
    InterFacilityConnectionToSupplierForCreation:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        target:
          $ref: '#/components/schemas/InterFacilityConnectionSupplierTarget'
        type:
          $ref: '#/components/schemas/ConnectionType'
      required:
        - target
        - type
      type: object
      xml:
        name: InterFacilityConnectionToSupplierForCreation
      title: InterFacilityConnectionToSupplierForCreation
      description: InterFacilityConnectionToSupplierForCreation
    InterFacilityConnectionToSupplierForUpdate:
      additionalProperties: false
      properties:
        carrierKey:
          description: >-
            The key of the carrier that is used for this connection. References
            known and configured carriers in the system.
          example: DHL_V2
          type: string
        carrierName:
          description: The name of the carrier that is used for this connection.
          example: DHL
          type: string
        context:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionContext'
          maxItems: 2000
          minItems: 0
          type: array
        customAttributes:
          additionalProperties: true
          description: >-
            Custom attributes that can be used to store additional information
            about the connection.
          type: object
        cutoffTimes:
          $ref: '#/components/schemas/CarrierCutoffTimes'
        fallbackCosts:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        fallbackTransitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        nonDeliveryDays:
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          type: array
        packagingUnitsByContexts:
          items:
            $ref: '#/components/schemas/PackagingUnitsByContext'
          maxItems: 2000
          minItems: 0
          type: array
        target:
          $ref: '#/components/schemas/InterFacilityConnectionSupplierTarget'
        type:
          $ref: '#/components/schemas/ConnectionType'
        version:
          type: number
      required:
        - target
        - version
        - type
      type: object
      xml:
        name: InterFacilityConnectionToSupplierForUpdate
      title: InterFacilityConnectionToSupplierForUpdate
      description: InterFacilityConnectionToSupplierForUpdate
    InventoryArticle:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        attributes:
          items:
            $ref: '#/components/schemas/ListingAttributeItem'
          type: array
        imageUrl:
          type: string
        tenantArticleId:
          type: string
        title:
          type: string
      required:
        - imageUrl
        - tenantArticleId
        - title
      title: InventoryArticle
      type: object
      description: InventoryArticle
    InventoryArticleAvailabilityChangedEventScope:
      properties:
        created:
          format: date-time
          type: string
        facilityGroupRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
        facilityRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
        id:
          type: string
        key:
          type: string
        lastModified:
          format: date-time
          type: string
        status:
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          type: number
      required:
        - id
        - key
        - status
        - version
        - created
        - lastModified
      title: InventoryArticleAvailabilityChangedEventScope
      type: object
      description: InventoryArticleAvailabilityChangedEventScope
    InventoryArticleAvailabilityChangedEventScopeForCreation:
      properties:
        facilityGroupRefs:
          description: >-
            Facility group references whose members are included in this scope.
            Omit or null for a global scope including all facilities.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 5
          nullable: true
          type: array
        facilityRefs:
          description: >-
            Direct facility references to include in this scope. Omit or null
            for a global scope including all facilities.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          nullable: true
          type: array
        key:
          description: Unique key identifying this scope. Used to derive the URN.
          maxLength: 128
          type: string
        status:
          default: ACTIVE
          description: >-
            A scope config can be set to inactive instead of being deleted to
            temporarily disable emission. The maximum limit of 10 applies to
            both active and inactive scope configs.
          enum:
            - ACTIVE
            - INACTIVE
          example: ACTIVE
          type: string
      required:
        - key
      title: InventoryArticleAvailabilityChangedEventScopeForCreation
      type: object
      description: InventoryArticleAvailabilityChangedEventScopeForCreation
    InventoryArticleAvailabilityChangedEventScopeForReplace:
      properties:
        facilityGroupRefs:
          description: >-
            Facility group references whose members are included in this scope.
            Omit or null for a global scope including all facilities.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 5
          nullable: true
          type: array
        facilityRefs:
          description: >-
            Direct facility references to include in this scope. Omit or null
            for a global scope including all facilities.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          nullable: true
          type: array
        status:
          description: >-
            A scope config can be set to inactive instead of being deleted to
            temporarily disable emission. The maximum limit of 10 applies to
            both active and inactive scope configs.
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          description: Version for optimistic locking.
          example: 1
          type: number
      required:
        - version
      title: InventoryArticleAvailabilityChangedEventScopeForReplace
      type: object
      description: InventoryArticleAvailabilityChangedEventScopeForReplace
    InventoryArticleAvailabilityChangedPayload:
      properties:
        articleAvailability:
          $ref: '#/components/schemas/ArticleAvailabilityStockValues'
        configurationScopeKey:
          type: string
        emittedAt:
          format: date-time
          type: string
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - configurationScopeKey
        - articleAvailability
        - emittedAt
      title: InventoryArticleAvailabilityChangedPayload
      type: object
      description: InventoryArticleAvailabilityChangedPayload
    InventoryArticleAvailabilityChangedPayloadWebHookEvent:
      properties:
        payload:
          $ref: '#/components/schemas/InventoryArticleAvailabilityChangedPayload'
      required:
        - payload
      title: InventoryArticleAvailabilityChangedPayloadWebHookEvent
      type: object
      description: InventoryArticleAvailabilityChangedPayloadWebHookEvent
    InventoryArticlePaginatedResult:
      properties:
        articles:
          items:
            $ref: '#/components/schemas/InventoryArticle'
          type: array
        pageInfo:
          $ref: '#/components/schemas/PageInfo'
        total:
          minimum: 0
          type: number
      required:
        - total
        - pageInfo
        - articles
      title: InventoryArticlePaginatedResult
      type: object
      description: InventoryArticlePaginatedResult
    InventoryAvailabilityTimeframe:
      properties:
        start:
          format: date-time
          type: string
      title: InventoryAvailabilityTimeframe
      type: object
      description: InventoryAvailabilityTimeframe
    InventoryAvailableUntilDefinition:
      properties:
        calculationBase:
          enum:
            - CREATION
            - EXPIRY
          type: string
        modifier:
          type: string
      required:
        - calculationBase
      title: InventoryAvailableUntilDefinition
      type: object
      description: InventoryAvailableUntilDefinition
    InventoryConfiguration:
      properties:
        isMixedStorage:
          type: boolean
        version:
          type: number
      required:
        - version
      title: InventoryConfiguration
      type: object
      description: InventoryConfiguration
    InventoryConfigurationForPatch:
      properties:
        isMixedStorage:
          example: true
          nullable: true
          type: boolean
        version:
          type: number
      required:
        - version
      title: InventoryConfigurationForPatch
      type: object
      description: InventoryConfigurationForPatch
    InventoryFacilityConfiguration:
      properties:
        facilityRef:
          type: string
        id:
          type: string
        isMixedStorage:
          type: boolean
        outboundStockConfiguration:
          $ref: '#/components/schemas/OutboundStockConfiguration'
        version:
          type: number
      required:
        - id
        - version
        - facilityRef
      title: InventoryFacilityConfiguration
      type: object
      description: InventoryFacilityConfiguration
    InventoryFacilityConfigurationForPatch:
      properties:
        isMixedStorage:
          example: true
          nullable: true
          type: boolean
        outboundStockConfiguration:
          $ref: '#/components/schemas/OutboundStockConfiguration'
        version:
          type: number
      required:
        - version
      title: InventoryFacilityConfigurationForPatch
      type: object
      description: InventoryFacilityConfigurationForPatch
    InventoryFacilityReferences:
      properties:
        facilityRef:
          type: string
        tenantFacilityId:
          type: string
      required:
        - facilityRef
      title: InventoryFacilityReferences
      type: object
      description: InventoryFacilityReferences
    InventoryFacilityStockChangedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          items:
            $ref: '#/components/schemas/InventoryFacilityStockShape'
          type: array
      required:
        - payload
      type: object
      title: InventoryFacilityStockChangedWebHookEvent
      description: InventoryFacilityStockChangedWebHookEvent
    InventoryFacilityStockDeltaShape:
      properties:
        available:
          deprecated: true
          type: number
        availableForPicking:
          type: number
        availableForPickingDetails:
          $ref: '#/components/schemas/AvailableForPickingDetails'
        availableOnStock:
          type: number
        availableToPromise:
          deprecated: true
          type: number
        byTrait:
          $ref: '#/components/schemas/InventoryFacilityStockShapeByTrait'
        readyToPick:
          deprecated: true
          type: number
        reserved:
          type: number
        safetyStock:
          type: number
        stockCount:
          type: number
        stockOnHand:
          type: number
        totalAmount:
          type: number
      required:
        - totalAmount
        - reserved
        - safetyStock
        - available
        - byTrait
        - availableToPromise
        - readyToPick
        - availableForPicking
        - stockCount
        - availableOnStock
        - stockOnHand
        - availableForPickingDetails
      title: InventoryFacilityStockDeltaShape
      type: object
      description: InventoryFacilityStockDeltaShape
    InventoryFacilityStockShape:
      properties:
        available:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        availableForPicking:
          type: number
        availableForPickingDetails:
          $ref: '#/components/schemas/AvailableForPickingDetails'
        availableOnStock:
          type: number
        availableToPromise:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        byTrait:
          $ref: '#/components/schemas/InventoryFacilityStockShapeByTrait'
        changeReason:
          enum:
            - UNKNOWN
          type: string
        delta:
          $ref: '#/components/schemas/InventoryFacilityStockDeltaShape'
        facility:
          $ref: '#/components/schemas/InventoryFacilityReferences'
        facilityRef:
          type: string
        readyToPick:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        reserved:
          type: number
        safetyStock:
          type: number
        staleReasons:
          items:
            $ref: '#/components/schemas/InventoryFacilityStockStaleReason'
          type: array
        stockOnHand:
          type: number
        tenantArticleId:
          type: string
        totalAmount:
          type: number
      required:
        - facilityRef
        - facility
        - tenantArticleId
        - totalAmount
        - reserved
        - safetyStock
        - available
        - byTrait
        - changeReason
        - availableToPromise
        - readyToPick
        - availableForPicking
        - availableForPickingDetails
        - delta
        - staleReasons
        - stockOnHand
        - availableOnStock
      title: InventoryFacilityStockShape
      type: object
      description: InventoryFacilityStockShape
    InventoryFacilityStockShapeByTrait:
      properties:
        ACCESSIBLE:
          type: number
        PICKABLE:
          type: number
      required:
        - PICKABLE
        - ACCESSIBLE
      title: InventoryFacilityStockShapeByTrait
      type: object
      description: InventoryFacilityStockShapeByTrait
    InventoryFacilityStockStaleReason:
      properties:
        reasons:
          items:
            type: string
          type: array
        timestamp:
          format: date-time
          type: string
      required:
        - timestamp
        - reasons
      title: InventoryFacilityStockStaleReason
      type: object
      description: InventoryFacilityStockStaleReason
    InventoryListingAttributeItem:
      properties:
        valueLocalized:
          additionalProperties:
            type: string
          description: >-
            Provides localized values. The key is the locale, the value is the
            translation.
            https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
          example:
            de_DE: Wert
            en_US: Value
            ru_RU: значение
          type: object
        keyLocalized:
          additionalProperties:
            type: string
          description: >-
            Provides localized values. The key is the locale, the value is the
            translation.
            https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
          example:
            de_DE: Wert
            en_US: Value
            ru_RU: значение
          type: object
        category:
          enum:
            - descriptive
            - miscellaneous
            - pickingSequence
            - customs
            - insurance
            - shop
            - dimensions
            - carrierService
            - salesPrice
            - basePrice
            - tax
            - discount
            - surcharge
            - subtotalBeforeDiscounts
            - subtotalAfterDiscounts
            - finalUnitPrice
            - finalLineItemPrice
          type: string
        key:
          type: string
        priority:
          type: number
        value:
          type: string
      required:
        - key
        - value
      title: InventoryListingAttributeItem
      type: object
      description: InventoryListingAttributeItem
    InventoryListingEventPayload:
      properties:
        titleLocalized:
          additionalProperties:
            type: string
          description: >-
            Provides localized values. The key is the locale, the value is the
            translation.
            https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
          example:
            de_DE: Wert
            en_US: Value
            ru_RU: значение
          type: object
        attributes:
          items:
            $ref: '#/components/schemas/InventoryListingAttributeItem'
          type: array
        availabilityTimeframe:
          allOf:
            - $ref: '#/components/schemas/InventoryAvailabilityTimeframe'
          example: 2026-06-17T12:00:00.000Z
        categoryRefs:
          items:
            type: string
          type: array
        created:
          format: date-time
          type: string
        currency:
          description: The currency of the price as an ISO 4217 code.
          enum:
            - AED
            - AFN
            - ALL
            - AMD
            - ANG
            - AOA
            - ARS
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - BMD
            - BND
            - BOB
            - BOV
            - BRL
            - BSD
            - BTN
            - BWP
            - BYN
            - BZD
            - CAD
            - CDF
            - CHE
            - CHF
            - CHW
            - CLF
            - CLP
            - CNY
            - COP
            - COU
            - CRC
            - CUC
            - CUP
            - CVE
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - ERN
            - ETB
            - EUR
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LYD
            - MAD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRU
            - MUR
            - MVR
            - MWK
            - MXN
            - MXV
            - MYR
            - MZN
            - NAD
            - NGN
            - NIO
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLE
            - SOS
            - SRD
            - SSP
            - STN
            - SVC
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - USD
            - USN
            - UYI
            - UYU
            - UYW
            - UZS
            - VED
            - VES
            - VND
            - VUV
            - WST
            - XAF
            - XAG
            - XAU
            - XBA
            - XBB
            - XBC
            - XBD
            - XCD
            - XDR
            - XOF
            - XPD
            - XPF
            - XPT
            - XSU
            - XTS
            - XUA
            - XXX
            - YER
            - ZAR
            - ZMW
            - ZWL
          type: string
        customAttributes:
          type: object
        facilityId:
          type: string
        id:
          type: string
        imageUrl:
          type: string
        lastModified:
          format: date-time
          type: string
        measurementUnitKey:
          type: string
        outOfStockBehaviour:
          enum:
            - NONE
            - BACKORDER
            - PREORDER
            - RESTOCK
            - PREORDER_AND_RESTOCK
          type: string
        outOfStockBehaviourByContexts:
          items:
            $ref: '#/components/schemas/InventoryOutOfStockBehaviourByContext'
          type: array
        outOfStockConfig:
          $ref: '#/components/schemas/InventoryOutOfStockConfig'
        price:
          type: number
        recordableAttributes:
          items:
            $ref: '#/components/schemas/InventoryRecordableAttribute'
          type: array
        scannableCodes:
          items:
            type: string
          type: array
        scanningRule:
          $ref: '#/components/schemas/InventoryScanningRuleConfiguration'
        status:
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        stockAvailableUntil:
          $ref: '#/components/schemas/InventoryAvailableUntilDefinition'
        stockProperties:
          additionalProperties:
            $ref: '#/components/schemas/InventoryStockPropertyDefinition'
          type: object
        tenantArticleId:
          type: string
        title:
          type: string
        version:
          type: number
        weight:
          type: number
        tags:
          items:
            $ref: '#/components/schemas/InventoryTagReference'
          type: array
      required:
        - id
        - version
        - created
        - lastModified
        - facilityId
        - tenantArticleId
        - status
      title: InventoryListingEventPayload
      type: object
      description: InventoryListingEventPayload
    InventoryOutOfStockBehaviourByContext:
      properties:
        context:
          description: >-
            The context of the outOfStockBehaviour. This is used to determine
            the conditions under which the outOfStockBehaviour can be applied.
          items:
            $ref: '#/components/schemas/InventoryOutOfStockBehaviourContext'
          type: array
        outOfStockBehaviour:
          enum:
            - NONE
            - BACKORDER
            - PREORDER
            - RESTOCK
            - PREORDER_AND_RESTOCK
          type: string
        outOfStockConfig:
          $ref: '#/components/schemas/InventoryOutOfStockConfig'
        priority:
          description: >-
            This value gives the priority in the respective
            OutOfStockBehaviourByContexts. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10.
          type: number
      required:
        - outOfStockBehaviour
        - context
        - priority
      title: InventoryOutOfStockBehaviourByContext
      type: object
      description: InventoryOutOfStockBehaviourByContext
    InventoryOutOfStockBehaviourContext:
      properties:
        operator:
          enum:
            - NOT
          type: string
        type:
          enum:
            - FACILITY_GROUP
            - TAG_REFERENCE
          type: string
        values:
          description: >-
            The values of the context. This is used to determine the conditions
            under which the outOfStockBehaviour can be applied.
          items:
            type: string
          type: array
      required:
        - type
        - values
      title: InventoryOutOfStockBehaviourContext
      type: object
      description: InventoryOutOfStockBehaviourContext
    InventoryOutOfStockConfig:
      properties:
        preorder:
          $ref: '#/components/schemas/InventoryOutOfStockConfigPreorder'
        restock:
          $ref: '#/components/schemas/InventoryOutOfStockConfigRestock'
      title: InventoryOutOfStockConfig
      type: object
      description: InventoryOutOfStockConfig
    InventoryOutOfStockConfigPreorder:
      properties:
        availabilityTimeframe:
          allOf:
            - $ref: '#/components/schemas/InventoryAvailabilityTimeframe'
          example: 2026-06-17T12:00:00.000Z
      required:
        - availabilityTimeframe
      title: InventoryOutOfStockConfigPreorder
      type: object
      description: InventoryOutOfStockConfigPreorder
    InventoryOutOfStockConfigRestock:
      properties:
        restockableInDays:
          type: number
      required:
        - restockableInDays
      title: InventoryOutOfStockConfigRestock
      type: object
      description: InventoryOutOfStockConfigRestock
    InventoryRecordableAttribute:
      properties:
        keyLocalized:
          type: object
        recordingRule:
          type: string
        value:
          type: string
      required:
        - keyLocalized
        - recordingRule
      title: InventoryRecordableAttribute
      type: object
      description: InventoryRecordableAttribute
    InventoryScanningRuleConfiguration:
      properties:
        values:
          items:
            $ref: '#/components/schemas/InventoryScanningRuleValue'
          type: array
      title: InventoryScanningRuleConfiguration
      type: object
      description: InventoryScanningRuleConfiguration
    InventoryScanningRuleValue:
      properties:
        priority:
          type: number
        scanningRuleType:
          enum:
            - ARTICLE
            - LOCATION
          type: string
      required:
        - priority
        - scanningRuleType
      title: InventoryScanningRuleValue
      type: object
      description: InventoryScanningRuleValue
    InventoryStockBulkWebHookEvent:
      properties:
        payload:
          $ref: '#/components/schemas/InventoryStockWebHookEventPayload'
      required:
        - payload
      title: InventoryStockBulkWebHookEvent
      type: object
      description: InventoryStockBulkWebHookEvent
    InventoryStockDelta:
      properties:
        previousLocationRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        reserved:
          type: number
        stockCount:
          type: number
        value:
          type: number
      required:
        - previousLocationRef
        - value
        - reserved
        - stockCount
      title: InventoryStockDelta
      type: object
      description: InventoryStockDelta
    InventoryStockPropertyDefinition:
      properties:
        inputType:
          enum:
            - DATE
            - TEXT
          type: string
        required:
          type: boolean
      required:
        - inputType
        - required
      title: InventoryStockPropertyDefinition
      type: object
      description: InventoryStockPropertyDefinition
    InventoryStockWebHookEventPayload:
      properties:
        items:
          items:
            $ref: '#/components/schemas/InventoryStockWebHookEventPayloadItem'
          type: array
      required:
        - items
      title: InventoryStockWebHookEventPayload
      type: object
      description: InventoryStockWebHookEventPayload
    InventoryStockWebHookEventPayloadItem:
      properties:
        available:
          type: number
        availableUntil:
          description: >-
            defines until when a stock is included in the stock availability as
            available and used for routing
          format: date-time
          type: string
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        delta:
          $ref: '#/components/schemas/InventoryStockDelta'
        facility:
          $ref: '#/components/schemas/StockFacilityReferences'
        facilityRef:
          description: facility in which the stock is located
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        facilityWideReserved:
          deprecated: true
          type: number
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        locationRef:
          description: location on which the stock is placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        properties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
          description: >-
            allow tracking of specific values such as expiry dates on a set of
            items. They should describe physical identifiable properties of the
            stock and are not meant to be used for metadata (see
            "customAttributes" for that).
        receiptDate:
          description: >-
            date-time when stock has entered the system, defaults to the
            creation date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        reserved:
          description: amount of this stock reserved for customer orders
          type: number
        scannableCodes:
          description: scannableCodes such as barcodes that identify this stock
          items:
            type: string
          type: array
        scores:
          description: >-
            stock with a high score can used preferably over stock with a lower
            score in routing, depending on configuration. The score can
            represent different attributes of the stock like zone, storage
            location, expiry date or receipt date.
          items:
            $ref: '#/components/schemas/Score'
          type: array
        serializedProperties:
          description: >-
            properties object serialized as JSON string, sorted alphabetically
            by key
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock
          example: MY_ARTICLE_ID
          minLength: 1
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        traits:
          description: >-
            provide information on how storage locations and stocks are to be
            handled in operational processes. Can only be set via
            storageLocation. 
          items:
            enum:
              - PICKABLE
              - ACCESSIBLE
              - KEEP_ON_ZERO
              - OUTBOUND
              - IN_MOTION
            type: string
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
        version:
          type: number
      required:
        - tenantArticleId
        - value
        - reserved
        - facilityWideReserved
        - facilityRef
        - facility
        - available
        - id
        - version
        - created
        - lastModified
        - traits
        - serializedProperties
        - delta
      title: InventoryStockWebHookEventPayloadItem
      type: object
      description: InventoryStockWebHookEventPayloadItem
    InventoryTagReference:
      properties:
        id:
          type: string
        value:
          type: string
      required:
        - id
        - value
      title: InventoryTagReference
      type: object
      description: InventoryTagReference
    ItemReturn:
      properties:
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        parcelRefs:
          description: references the parcel
          example: 672f3f72-b5d3-47c7-941c-9af5348e3cd7
          items:
            type: string
          maxItems: 50
          type: array
        returnedLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnLineItem'
          maxItems: 100
          minItems: 0
          type: array
        returnedNotReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnNotReturnableLineItem'
          maxItems: 100
          minItems: 0
          type: array
        returnFacilityRef:
          type: string
        scannableCodes:
          items:
            type: string
          maxItems: 50
          type: array
        status:
          enum:
            - ANNOUNCED
            - OPEN
            - IN_PROGRESS
            - PAUSED
            - FINISHED
            - WAITING_FOR_INPUT
            - CANCELED
            - OBSOLETE
          type: string
        tenantOrderId:
          deprecated: true
          description: >-
            deprecated: will be automatically deducted from related
            itemReturnJob
          example: MY_ORDER_ID
          type: string
      required:
        - id
        - returnFacilityRef
        - status
        - returnedLineItems
      title: ItemReturn
      type: object
      description: ItemReturn
    ItemReturnForCreation:
      properties:
        returnedLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemForCreation'
          maxItems: 100
          minItems: 0
          type: array
        returnedNotReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemForCreation'
          maxItems: 100
          minItems: 0
          type: array
        returnFacilityRef:
          type: string
        scannableCodes:
          items:
            type: string
          maxItems: 50
          type: array
        status:
          enum:
            - ANNOUNCED
            - OPEN
            - IN_PROGRESS
            - PAUSED
            - FINISHED
            - WAITING_FOR_INPUT
            - CANCELED
            - OBSOLETE
          type: string
        tenantOrderId:
          deprecated: true
          description: >-
            deprecated: will be automatically deducted from related
            itemReturnJob
          example: MY_ORDER_ID
          type: string
      required:
        - status
        - returnFacilityRef
        - returnedLineItems
      title: ItemReturnForCreation
      type: object
      description: ItemReturnForCreation
    ItemReturnJob:
      properties:
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        consumerAddresses:
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          type: array
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        itemReturns:
          items:
            $ref: '#/components/schemas/ItemReturn'
          maxItems: 100
          minItems: 0
          type: array
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        notReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItem'
          maxItems: 100
          minItems: 0
          type: array
        originFacilityRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
        processRef:
          type: string
        returnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItem'
          maxItems: 100
          minItems: 0
          type: array
        scannableCodes:
          items:
            type: string
          maxItems: 50
          type: array
        shortId:
          description: >-
            A short identifier that helps assigning a item return job to a
            customer. This is automatically created during creation.
          example: AS12
          type: string
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELED
          type: string
        tenantOrderId:
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 1
          type: integer
      required:
        - id
        - version
        - processRef
        - originFacilityRefs
        - status
        - consumerAddresses
        - returnableLineItems
        - itemReturns
      title: ItemReturnJob
      type: object
      description: ItemReturnJob
    ItemReturnJobForCreation:
      properties:
        consumerAddresses:
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 5
          minItems: 1
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        notReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItemForCreation'
          maxItems: 100
          minItems: 0
          type: array
        originFacilityRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
        processRef:
          type: string
        returnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItemForCreation'
          maxItems: 100
          minItems: 0
          type: array
        scannableCodes:
          items:
            type: string
          maxItems: 50
          type: array
        shortId:
          description: >-
            A short identifier that helps assigning a item return job to a
            customer. This is automatically created during creation.
          example: AS12
          type: string
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELED
          type: string
        tenantOrderId:
          type: string
      required:
        - originFacilityRefs
        - status
        - consumerAddresses
        - returnableLineItems
      title: ItemReturnJobForCreation
      type: object
      description: ItemReturnJobForCreation
    ItemReturnJobLineItem:
      properties:
        article:
          $ref: '#/components/schemas/ItemReturnJobLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        delivered:
          description: Quantity of this line item that has been delivered
          example: 7
          type: number
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: Generated identifier of this entity
          example: 611c860f-3f00-4b01-9f4c-64cdee38a30e
          type: string
        notReturnableItemsExists:
          deprecated: true
          description: Add items to notReturnableLineItems array in itemReturnJob instead.
          type: boolean
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          nullable: true
          type: array
        returnable:
          description: Quantity of this line item that can be returned
          example: 7
          minimum: 0
          type: number
        returned:
          description: Quantity of this line item that has been returned
          example: 5
          minimum: 0
          type: number
        scannableCodes:
          description: Codes that can be used for scanning this line item
          items:
            type: string
          maxItems: 50
          type: array
        serviceJobRefs:
          description: >-
            refs of the service jobs that altered this line item during the
            workflow
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 100
          type: array
      required:
        - id
        - article
        - delivered
        - returned
        - returnable
      title: ItemReturnJobLineItem
      type: object
      description: ItemReturnJobLineItem
    ItemReturnJobLineItemArticle:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        attributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 100
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          type: string
        prices:
          deprecated: true
          description: >-
            Use attributes with keys: 'valuePerUnit', 'currency' and
            'numberOfDecimalPlaces'
          items:
            $ref: '#/components/schemas/ArticlePrice'
          maxItems: 50
          type: array
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          minimum: 0
          type: number
      required:
        - tenantArticleId
        - title
      title: ItemReturnJobLineItemArticle
      type: object
      description: ItemReturnJobLineItemArticle
    ItemReturnJobLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/ItemReturnJobLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        delivered:
          description: Quantity of this line item that has been delivered
          example: 7
          minimum: 1
          type: number
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        notReturnableItemsExists:
          deprecated: true
          description: Add items to notReturnableLineItems array in itemReturnJob instead.
          type: boolean
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          nullable: true
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this line item
          items:
            type: string
          maxItems: 50
          type: array
        serviceJobRefs:
          description: >-
            refs of the service jobs that altered this line item during the
            workflow
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 100
          type: array
      required:
        - article
        - delivered
      title: ItemReturnJobLineItemForCreation
      type: object
      description: ItemReturnJobLineItemForCreation
    ItemReturnJobs:
      properties:
        itemReturnJobsWithSearchPaths:
          items:
            $ref: '#/components/schemas/ItemReturnJobWithSearchPaths'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: number
      title: ItemReturnJobs
      type: object
      description: ItemReturnJobs
    ItemReturnJobWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ItemReturnJob'
      required:
        - payload
      type: object
      title: ItemReturnJobWebHookEvent
      description: ItemReturnJobWebHookEvent
    ItemReturnJobWithSearchPaths:
      properties:
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        consumerAddresses:
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          type: array
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        itemReturns:
          items:
            $ref: '#/components/schemas/ItemReturn'
          maxItems: 100
          minItems: 0
          type: array
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        notReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItem'
          maxItems: 100
          minItems: 0
          type: array
        originFacilityRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
        processRef:
          type: string
        returnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItem'
          maxItems: 100
          minItems: 0
          type: array
        scannableCodes:
          items:
            type: string
          maxItems: 50
          type: array
        searchPaths:
          items:
            type: string
          maxItems: 500
          type: array
        shortId:
          description: >-
            A short identifier that helps assigning a item return job to a
            customer. This is automatically created during creation.
          example: AS12
          type: string
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELED
          type: string
        tenantOrderId:
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 1
          type: integer
      required:
        - id
        - version
        - processRef
        - originFacilityRefs
        - status
        - consumerAddresses
        - returnableLineItems
        - itemReturns
      title: ItemReturnJobWithSearchPaths
      type: object
      description: ItemReturnJobWithSearchPaths
    ItemReturnLineItem:
      properties:
        itemConditionLocalized:
          $ref: '#/components/schemas/LocaleString'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        decisionReason:
          $ref: '#/components/schemas/ItemReturnLineItemReason'
        id:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
        itemCondition:
          example: Damaged
          type: string
        itemConditionComment:
          example: Upper corner damaged
          minLength: 1
          type: string
        itemReturnJobLineItemRefs:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        reasons:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemReason'
          maxItems: 20
          type: array
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          maxItems: 50
          nullable: true
          type: array
        refund:
          $ref: '#/components/schemas/ReturnedLineItemRefund'
        scannedCodes:
          items:
            type: string
          maxItems: 50
          type: array
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - WAITING_FOR_INPUT
            - REJECTED
            - ACCEPTED
            - CANCELED
          type: string
        tenantArticleId:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
      required:
        - id
        - itemReturnJobLineItemRefs
        - tenantArticleId
        - status
      title: ItemReturnLineItem
      type: object
      description: ItemReturnLineItem
    ItemReturnLineItemForCreation:
      properties:
        itemConditionLocalized:
          $ref: '#/components/schemas/LocaleString'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        decisionReason:
          $ref: '#/components/schemas/ItemReturnLineItemReasonForUpsert'
        itemConditionComment:
          example: Upper corner damaged
          minLength: 1
          type: string
        itemReturnJobLineItemRef:
          description: id of the item return job line item that is returned
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
        reasons:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemReason'
          maxItems: 20
          type: array
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          nullable: true
          type: array
        scannedCodes:
          items:
            type: string
          maxItems: 50
          type: array
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - WAITING_FOR_INPUT
            - REJECTED
            - ACCEPTED
            - CANCELED
          type: string
        tenantArticleId:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
      required:
        - itemReturnJobLineItemRef
        - status
      title: ItemReturnLineItemForCreation
      type: object
      description: ItemReturnLineItemForCreation
    ItemReturnLineItemForUpdate:
      properties:
        decisionReason:
          $ref: '#/components/schemas/ItemReturnLineItemReasonForUpsert'
        itemReturnJobVersion:
          description: version of the overlaying itemReturnJob
          example: 42
          type: integer
        refund:
          $ref: '#/components/schemas/ReturnedLineItemRefund'
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - WAITING_FOR_INPUT
            - REJECTED
            - ACCEPTED
            - CANCELED
          type: string
      required:
        - itemReturnJobVersion
      title: ItemReturnLineItemForUpdate
      type: object
      description: ItemReturnLineItemForUpdate
    ItemReturnLineItemReason:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        comment:
          example: Upper corner damaged
          minLength: 1
          type: string
        reason:
          description: Translated reasonLocalized
          type: string
      required:
        - reasonLocalized
      title: ItemReturnLineItemReason
      type: object
      description: ItemReturnLineItemReason
    ItemReturnLineItemReasonForUpsert:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        comment:
          example: Upper corner damaged
          minLength: 1
          type: string
      required:
        - reasonLocalized
      title: ItemReturnLineItemReasonForUpsert
      type: object
      description: ItemReturnLineItemReasonForUpsert
    ItemReturnNotReturnableLineItem:
      properties:
        itemConditionLocalized:
          $ref: '#/components/schemas/LocaleString'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        decisionReason:
          $ref: '#/components/schemas/ItemReturnLineItemReason'
        id:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
        itemCondition:
          example: Damaged
          type: string
        itemConditionComment:
          example: Upper corner damaged
          minLength: 1
          type: string
        itemReturnJobLineItemRefs:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        reasons:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemReason'
          maxItems: 20
          type: array
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          maxItems: 50
          nullable: true
          type: array
        scannedCodes:
          items:
            type: string
          maxItems: 50
          type: array
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - WAITING_FOR_INPUT
            - REJECTED
            - ACCEPTED
            - CANCELED
          type: string
        tenantArticleId:
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
      required:
        - id
        - itemReturnJobLineItemRefs
        - tenantArticleId
        - status
      title: ItemReturnNotReturnableLineItem
      type: object
      description: ItemReturnNotReturnableLineItem
    ItemReturnNotReturnableLineItemForUpdate:
      properties:
        decisionReason:
          $ref: '#/components/schemas/ItemReturnLineItemReasonForUpsert'
        itemReturnJobVersion:
          description: version of the overlaying itemReturnJob
          example: 42
          type: integer
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - WAITING_FOR_INPUT
            - REJECTED
            - ACCEPTED
            - CANCELED
          type: string
      required:
        - itemReturnJobVersion
      title: ItemReturnNotReturnableLineItemForUpdate
      type: object
      description: ItemReturnNotReturnableLineItemForUpdate
    ItemReturns:
      properties:
        itemReturns:
          items:
            $ref: '#/components/schemas/ItemReturnsWithSearchPaths'
          maxItems: 500
          type: array
        totalCount:
          description: Total number of found entities for this query
          example: 42
          type: number
      required:
        - itemReturns
        - totalCount
      title: ItemReturns
      type: object
      description: ItemReturns
    ItemReturnsWithSearchPaths:
      properties:
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        parcelRefs:
          description: references the parcel
          example: 672f3f72-b5d3-47c7-941c-9af5348e3cd7
          items:
            type: string
          maxItems: 50
          type: array
        returnedLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnLineItem'
          maxItems: 100
          minItems: 0
          type: array
        returnedNotReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnNotReturnableLineItem'
          maxItems: 100
          minItems: 0
          type: array
        returnFacilityRef:
          type: string
        scannableCodes:
          items:
            type: string
          maxItems: 50
          type: array
        searchPaths:
          items:
            type: string
          maxItems: 500
          type: array
        status:
          enum:
            - ANNOUNCED
            - OPEN
            - IN_PROGRESS
            - PAUSED
            - FINISHED
            - WAITING_FOR_INPUT
            - CANCELED
            - OBSOLETE
          type: string
        tenantOrderId:
          deprecated: true
          description: >-
            deprecated: will be automatically deducted from related
            itemReturnJob
          example: MY_ORDER_ID
          type: string
      required:
        - id
        - returnFacilityRef
        - status
        - returnedLineItems
        - searchPaths
      title: ItemReturnsWithSearchPaths
      type: object
      description: ItemReturnsWithSearchPaths
    KeyExistsFilter:
      properties:
        exists:
          description: Search all entities which have or do not have this key defined
          type: boolean
      title: KeyExistsFilter
      type: object
      description: KeyExistsFilter
    Label:
      properties:
        additionalDocuments:
          description: Additional documents attached to the label
          items:
            $ref: '#/components/schemas/LabelAdditionalDocument'
          maxItems: 20
          type: array
        anonymized:
          description: Whether the label data has been anonymized
          type: boolean
        carrierData:
          allOf:
            - $ref: '#/components/schemas/LabelCarrierData'
          description: Carrier and product details
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        customAttributes:
          additionalProperties: true
          description: Custom attributes
          type: object
        facilityRef:
          description: Reference to the connected facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: Unique identifier of the label
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        labelUrl:
          description: URL to download the label document
          example: https://example.com/resource
          type: string
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        operativeProcessRef:
          description: Reference to the operative process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        packageRef:
          description: Reference to the package
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        processRef:
          description: Reference to the fulfillment process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        recipientAddress:
          description: Recipient addresses
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 10
          type: array
        senderAddress:
          $ref: '#/components/schemas/FacilityAddress'
        shippingInformationRef:
          description: Reference to the shipping information
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        shortId:
          description: Short human-readable identifier
          type: string
        status:
          description: Current status of the label
          enum:
            - WAITING_FOR_INPUT
            - REQUESTABLE
            - REQUESTED
            - SUCCESSFUL
            - FAILED
            - CANCELLED
            - OBSOLETE
          type: string
        tenantLabelId:
          description: Tenant-specific label identifier
          example: MY_LABEL_ID
          type: string
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        type:
          description: Type of label
          enum:
            - SEND_LABEL
            - RETURN_LABEL
          type: string
        version:
          description: Optimistic locking version
          example: 1
          type: integer
      required:
        - id
        - status
        - processRef
        - operativeProcessRef
        - facilityRef
        - shippingInformationRef
        - additionalDocuments
        - carrierData
        - senderAddress
        - recipientAddress
        - type
        - anonymized
        - created
        - lastModified
        - version
      title: Label
      type: object
      description: Label
    LabelAdditionalDocument:
      properties:
        nameLocalized:
          additionalProperties: true
          description: Localized name of the document
          type: object
        url:
          description: URL to the additional document
          example: https://example.com/resource
          type: string
      required:
        - url
        - nameLocalized
      title: LabelAdditionalDocument
      type: object
      description: LabelAdditionalDocument
    LabelCarrierData:
      properties:
        carrierRef:
          description: Reference to the carrier
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        product:
          description: Carrier product identifier
          type: string
        services:
          description: Additional carrier services
          items:
            $ref: '#/components/schemas/CarrierService'
          maxItems: 20
          type: array
      required:
        - carrierRef
      title: LabelCarrierData
      type: object
      description: LabelCarrierData
    LabelForCreation:
      properties:
        additionalDocuments:
          description: Additional documents attached to the label
          items:
            $ref: '#/components/schemas/LabelAdditionalDocument'
          maxItems: 20
          type: array
        carrierData:
          allOf:
            - $ref: '#/components/schemas/LabelCarrierData'
          description: Carrier and product details
        customAttributes:
          additionalProperties: true
          description: Custom attributes
          type: object
        labelUrl:
          description: URL to download the label document
          example: https://example.com/resource
          type: string
        operativeProcessRef:
          description: Reference to the operative process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        packageRef:
          description: Reference to the package
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        processRef:
          description: Reference to the fulfillment process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        recipientAddress:
          description: Recipient addresses
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 10
          type: array
        senderAddress:
          $ref: '#/components/schemas/FacilityAddress'
        shippingInformationRef:
          description: Reference to the shipping information
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        shortId:
          description: Short human-readable identifier
          type: string
        status:
          description: Current status of the label
          enum:
            - WAITING_FOR_INPUT
            - REQUESTABLE
            - REQUESTED
            - SUCCESSFUL
            - FAILED
            - CANCELLED
            - OBSOLETE
          type: string
        tenantLabelId:
          description: Tenant-specific label identifier
          example: MY_LABEL_ID
          type: string
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        type:
          description: Type of label
          enum:
            - SEND_LABEL
            - RETURN_LABEL
          type: string
      required:
        - status
        - shippingInformationRef
        - additionalDocuments
        - carrierData
        - senderAddress
        - recipientAddress
        - type
      title: LabelForCreation
      type: object
      description: LabelForCreation
    LabelForUpdate:
      properties:
        anonymized:
          description: Whether the label data has been anonymized
          type: boolean
        carrierData:
          allOf:
            - $ref: '#/components/schemas/LabelCarrierData'
          description: Carrier and product details
        labelUrl:
          description: URL to download the label document
          example: https://example.com/resource
          type: string
        recipientAddress:
          description: Recipient addresses
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 10
          type: array
        senderAddress:
          $ref: '#/components/schemas/FacilityAddress'
        shortId:
          description: Short human-readable identifier
          type: string
        status:
          description: Current status of the label
          enum:
            - WAITING_FOR_INPUT
            - REQUESTABLE
            - REQUESTED
            - SUCCESSFUL
            - FAILED
            - CANCELLED
            - OBSOLETE
          type: string
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        type:
          description: Type of label
          enum:
            - SEND_LABEL
            - RETURN_LABEL
          type: string
        version:
          description: Optimistic locking version
          example: 1
          type: integer
      required:
        - version
      title: LabelForUpdate
      type: object
      description: LabelForUpdate
    LabelPaginatedResult:
      properties:
        labels:
          items:
            $ref: '#/components/schemas/Label'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - labels
      title: LabelPaginatedResult
      type: object
      description: LabelPaginatedResult
    LabelSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/LabelSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/LabelSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: LabelSearchPayload
      type: object
      description: LabelSearchPayload
    LabelSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/LabelSearchQuery'
          maxItems: 500
          type: array
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/LabelSearchQuery'
          maxItems: 500
          type: array
        processRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by processRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        tenantLabelId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantLabelId
          example: MY_LABEL_ID
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: LabelSearchQuery
      type: object
      description: LabelSearchQuery
    LabelSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: LabelSort
      type: object
      description: LabelSort
    LastDomainEntityStatusItem:
      description: >-
        An object holding the last DomainStatus of a given entity and its
        corresponding domain.
      properties:
        domain:
          $ref: '#/components/schemas/DomainType'
          description: The domain of the entity that caused the status change.
        entityId:
          description: The entity id
          type: string
        status:
          $ref: '#/components/schemas/DomainStatus'
          description: The status of the entity.
        subStatuses:
          description: >-
            The current sub-statuses of the entity, persisted to avoid reloading
            all progress logs on each recalculation.
          items:
            $ref: '#/components/schemas/ProcessSubStatus'
          type: array
      required:
        - domain
        - status
        - entityId
      type: object
      title: LastDomainEntityStatusItem
    LastModuleEntityStatusItem:
      properties:
        entityRef:
          type: string
        facilityRef:
          type: string
        moduleEntity:
          $ref: '#/components/schemas/ModuleEntity'
        status:
          $ref: '#/components/schemas/ModuleEntityStatus'
        subStatuses:
          items:
            $ref: '#/components/schemas/ProcessSubStatus'
          type: array
      required:
        - moduleEntity
        - status
        - entityRef
      type: object
      title: LastModuleEntityStatusItem
      description: LastModuleEntityStatusItem
    LatestPickingStart:
      allOf:
        - $ref: '#/components/schemas/PickingStartBase'
      properties:
        latestPickingStartDate:
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - latestPickingStartDate
      type: object
      title: LatestPickingStart
      description: LatestPickingStart
    LatestPickingStartForDecisionLog:
      properties:
        carrierRef:
          type: string
        latestPickingStartDate:
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        lpsCalculationHints:
          description: '@deprecated, use hints'
          items:
            type: string
          type: array
        targetTime:
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      type: object
      title: LatestPickingStartForDecisionLog
      description: LatestPickingStartForDecisionLog
    LineItem:
      properties:
        article:
          description: Information about the lineItem
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: ID of the recordable attribute
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - id
      title: LineItem
      type: object
      description: LineItem
    LineItemArticle:
      properties:
        titleLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations for the title of the product
        attributes:
          description: >-
            Attributes are used in fulfillmenttools to impose a certain degree
            of customization to a process, such as improving the appearance in
            fulfillmenttools clients. Details about usage can be found in the <a
            href=\"https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">article
            attributes article</a>.
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 50
          type: array
        customAttributes:
          deprecated: true
          description: 'Deprecated: use customAttributes on lineItem instead.'
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Ensure that no
            authentication is needed to fetch the image.
          example: https://example.com/resource
          type: string
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          description: Weight value is in gram
          minimum: 0
          type: number
      required:
        - title
        - tenantArticleId
      title: LineItemArticle
      type: object
      description: LineItemArticle
    LineItemForCreation:
      properties:
        article:
          description: Information about the lineItem
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      title: LineItemForCreation
      type: object
      description: LineItemForCreation
    LinkedConfiguration:
      properties:
        ref:
          type: string
        rel:
          type: string
      type: object
      title: LinkedConfiguration
      description: LinkedConfiguration
    LinkedServiceJobs:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        facilityRef:
          description: Id linked Facility from the includes service jobs
          example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          minLength: 1
          type: string
        fullIdentifier:
          description: >-
            Full identifier of the service job. Using the full name of the
            customer when created from an order.
          example: 240429_lorem-42
          minLength: 1
          type: string
        id:
          description: Unique ID of this linked service jobs group
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        includedServiceJobLinkIds:
          description: searchable field of all included service job link ids
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 500
          minItems: 1
          type: array
        includedServiceJobRefs:
          description: searchable field of all included service job ids
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 500
          minItems: 1
          type: array
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        operativeProcessRef:
          description: >-
            Reference to the operative process this linked service jobs group
            belongs to
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        processRef:
          description: >-
            ProcessRef of the added ServiceJobs. All Service Jobs need to be
            part of the same process
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        serviceJobLinks:
          description: Chain of service job links representing the execution order
          items:
            $ref: '#/components/schemas/ServiceJobLink'
          maxItems: 50
          minItems: 1
          type: array
        status:
          description: Current status of this linked service jobs group
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - OBSOLETE
            - NOT_READY
          example: OPEN
          type: string
        targetTime:
          description: >-
            Target time by which all linked service jobs are expected to be
            completed
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        usersModificationHistory:
          items:
            $ref: '#/components/schemas/UserModificationHistory'
          maxItems: 500
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - created
        - lastModified
        - version
        - id
        - processRef
        - facilityRef
        - targetTime
        - includedServiceJobLinkIds
        - includedServiceJobRefs
        - status
        - serviceJobLinks
      title: LinkedServiceJobs
      type: object
      description: LinkedServiceJobs
    LinkedServiceJobsPaginatedResult:
      properties:
        linkedServiceJobs:
          items:
            $ref: '#/components/schemas/LinkedServiceJobs'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - linkedServiceJobs
      title: LinkedServiceJobsPaginatedResult
      type: object
      description: LinkedServiceJobsPaginatedResult
    LinkedServiceJobsResult:
      properties:
        linkedServiceJobs:
          description: List of linked service jobs matching the query
          items:
            $ref: '#/components/schemas/LinkedServiceJobsWithSearchPaths'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          minimum: 0
          type: integer
      required:
        - total
        - linkedServiceJobs
      title: LinkedServiceJobsResult
      type: object
      description: LinkedServiceJobsResult
    LinkedServiceJobsSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/LinkedServiceJobsSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/LinkedServiceJobsSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: LinkedServiceJobsSearchPayload
      type: object
      description: LinkedServiceJobsSearchPayload
    LinkedServiceJobsSearchQuery:
      properties:
        additionalInformation:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by additionalInformation
        and:
          items:
            $ref: '#/components/schemas/LinkedServiceJobsSearchQuery'
          maxItems: 500
          type: array
        articleTitles:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by articleTitles
        channel:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by channel
        consumerName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by consumerName
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        invoiceAddress:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by invoiceAddress
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        linkedServiceJobRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by linkedServiceJobRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/LinkedServiceJobsSearchQuery'
          maxItems: 500
          type: array
        serviceName:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by serviceName
        shippingAddress:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by shippingAddress
        status:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by status
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
        usersModificationHistory:
          allOf:
            - $ref: >-
                #/components/schemas/LinkedServiceJobsUsersModificationHistoryListFilter
          description: Nested list search by usersModificationHistory
      title: LinkedServiceJobsSearchQuery
      type: object
      description: LinkedServiceJobsSearchQuery
    LinkedServiceJobsSort:
      properties:
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
      title: LinkedServiceJobsSort
      type: object
      description: LinkedServiceJobsSort
    LinkedServiceJobsUsersModificationHistoryFilter:
      properties:
        username:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by username
      title: LinkedServiceJobsUsersModificationHistoryFilter
      type: object
      description: LinkedServiceJobsUsersModificationHistoryFilter
    LinkedServiceJobsUsersModificationHistoryListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/LinkedServiceJobsUsersModificationHistoryFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: LinkedServiceJobsUsersModificationHistoryListFilter
      type: object
      description: LinkedServiceJobsUsersModificationHistoryListFilter
    LinkedServiceJobsWithSearchPaths:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        facilityRef:
          description: Id linked Facility from the includes service jobs
          example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          minLength: 1
          type: string
        fullIdentifier:
          description: >-
            Full identifier of the service job. Using the full name of the
            customer when created from an order.
          example: 240429_lorem-42
          minLength: 1
          type: string
        id:
          description: Unique ID of this linked service jobs group
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        includedServiceJobLinkIds:
          description: searchable field of all included service job link ids
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 500
          minItems: 1
          type: array
        includedServiceJobRefs:
          description: searchable field of all included service job ids
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 500
          minItems: 1
          type: array
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        operativeProcessRef:
          description: >-
            Reference to the operative process this linked service jobs group
            belongs to
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        processRef:
          description: >-
            ProcessRef of the added ServiceJobs. All Service Jobs need to be
            part of the same process
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        searchPaths:
          description: Search paths used for full-text search indexing of this entity
          items:
            type: string
          maxItems: 200
          type: array
        serviceJobLinks:
          description: Chain of service job links representing the execution order
          items:
            $ref: '#/components/schemas/ServiceJobLink'
          maxItems: 50
          minItems: 1
          type: array
        status:
          description: Current status of this linked service jobs group
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - OBSOLETE
            - NOT_READY
          example: OPEN
          type: string
        targetTime:
          description: >-
            Target time by which all linked service jobs are expected to be
            completed
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        usersModificationHistory:
          items:
            $ref: '#/components/schemas/UserModificationHistory'
          maxItems: 500
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - created
        - lastModified
        - version
        - id
        - processRef
        - facilityRef
        - targetTime
        - includedServiceJobLinkIds
        - includedServiceJobRefs
        - status
        - serviceJobLinks
        - searchPaths
      title: LinkedServiceJobsWithSearchPaths
      type: object
      description: LinkedServiceJobsWithSearchPaths
    Listing:
      allOf:
        - $ref: '#/components/schemas/ListingForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            facilityId:
              description: This is a reference to a facility
              example: '4711'
              type: string
            id:
              example: fsfdsf87fsd
              type: string
            partialStocks:
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 11th of
                September 2023. Use /api/stocks endpoints instead.
              items:
                $ref: '#/components/schemas/PartialStock'
              type: array
            recordableAttributes:
              description: >-
                Customizable information about the lineItem that can be set
                during the process.
              items:
                $ref: '#/components/schemas/ListingRecordableAttribute'
              maxItems: 40
              type: array
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
            status:
              enum:
                - ACTIVE
                - INACTIVE
              type: string
            stockinformation:
              $ref: '#/components/schemas/StockInformation'
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 11th of
                September 2023. Use /api/stocks endpoints instead.
          required:
            - status
            - facilityId
            - id
          type: object
      xml:
        name: Listing
      title: Listing
      description: Listing
    ListingAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      properties:
        valueLocalized:
          $ref: '#/components/schemas/LocaleString'
        keyLocalized:
          $ref: '#/components/schemas/LocaleString'
      title: ListingAttributeItem
      description: ListingAttributeItem
    ListingAvailabilityAnalysis:
      properties:
        availableForPicking:
          description: The quantity available for picking.
          type: number
        facilityId:
          description: The ID of the facility.
          type: string
        outOfStockBehaviour:
          description: The calculated out of stock behavior for the underlying order.
          enum:
            - NONE
            - BACKORDER
            - PREORDER
            - RESTOCK
            - PREORDER_AND_RESTOCK
          type: string
        tenantArticleId:
          description: The tenant article ID.
          example: MY_ARTICLE_ID
          type: string
      required:
        - facilityId
        - tenantArticleId
        - availableForPicking
        - outOfStockBehaviour
      title: ListingAvailabilityAnalysis
      type: object
      description: ListingAvailabilityAnalysis
    ListingAvailabilityTimeframeFilter:
      properties:
        start:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by start
      title: ListingAvailabilityTimeframeFilter
      type: object
      description: ListingAvailabilityTimeframeFilter
    ListingBulkOperationResult:
      properties:
        listing:
          $ref: '#/components/schemas/Listing'
        status:
          $ref: '#/components/schemas/BulkOperationResultStatus'
      required:
        - listing
        - status
      type: object
      title: ListingBulkOperationResult
      description: ListingBulkOperationResult
    ListingBulkUpsertPayload:
      properties:
        listings:
          description: >-
            List of listings to be upserted in bulk. Number of entries times
            selectors must not exceed 25.
          items:
            discriminator:
              mapping:
                MULTI_SELECTOR: '#/components/schemas/ListingForBulkUpsertBySelector'
                SINGLE_FACILITY: '#/components/schemas/ListingForBulkUpsertByFacility'
              propertyName: targetingStrategy
            oneOf:
              - $ref: '#/components/schemas/ListingForBulkUpsertBySelector'
              - $ref: '#/components/schemas/ListingForBulkUpsertByFacility'
          minItems: 1
          type: array
      required:
        - listings
      title: ListingBulkUpsertPayload
      type: object
      description: ListingBulkUpsertPayload
    ListingBulkUpsertResponse:
      properties:
        listings:
          description: Listings upsert operations that were successfully upserted.
          items:
            $ref: '#/components/schemas/ListingBulkUpsertSuccess'
          type: array
        summary:
          allOf:
            - $ref: '#/components/schemas/BulkUpsertSummary'
          description: Summary of the operations.
      required:
        - summary
        - listings
      title: ListingBulkUpsertResponse
      type: object
      description: ListingBulkUpsertResponse
    ListingBulkUpsertSuccess:
      properties:
        result:
          allOf:
            - $ref: '#/components/schemas/Listing'
          description: The resulting entity.
        status:
          description: Indicates whether the operation created or updated the entity.
          enum:
            - CREATED
            - UPDATED
            - UNCHANGED
          type: string
      required:
        - status
        - result
      title: ListingBulkUpsertSuccess
      type: object
      description: ListingBulkUpsertSuccess
    ListingBulkWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ListingWebHookEventPayload'
      required:
        - payload
      title: ListingBulkWebHookEvent
      type: object
      description: ListingBulkWebHookEvent
    ListingFacilitySelector:
      properties:
        facility:
          description: >-
            Selector for the facility. Either a facility reference or a tenant
            facility ID must be provided.
          oneOf:
            - $ref: '#/components/schemas/FacilityRefSelector'
            - $ref: '#/components/schemas/TenantFacilityIdSelector'
        version:
          description: >-
            Optional version of the facility. Must be provided for existing
            facilities. Leave empty for new facilities.
          example: 1
          type: number
      required:
        - facility
      title: ListingFacilitySelector
      type: object
      description: ListingFacilitySelector
    ListingForBulkUpsertByFacility:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        attributes:
          items:
            $ref: '#/components/schemas/ListingAttributeItem'
          maxItems: 40
          type: array
        categoryRefs:
          description: References to categories the listing belongs to.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 10
          type: array
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          deprecated: true
          description: >-
            Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          example: EUR
          nullable: true
          type: string
        customAttributes:
          additionalProperties: true
          description: >-
            Attributes that can be added to the listing. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facility:
          description: >-
            Selector for the facility. Either a facility reference or a tenant
            facility ID must be provided.
          oneOf:
            - $ref: '#/components/schemas/FacilityRefSelector'
            - $ref: '#/components/schemas/TenantFacilityIdSelector'
        imageUrl:
          description: >-
            A web link to a picture of this article. Please make sure that no
            authentication is required to fetch the image!
          example: https://example.com/resource
          type: string
        legal:
          $ref: '#/components/schemas/ListingLegal'
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        outOfStockBehaviourByContexts:
          description: >-
            The OutOfStockBehaviourByContexts is in Alpha status. For details,
            see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br/>
          items:
            $ref: '#/components/schemas/OutOfStockBehaviourByContext2'
          maxItems: 10
          minItems: 1
          type: array
        outOfStockConfig:
          allOf:
            - $ref: '#/components/schemas/OutOfStockConfig2'
          description: >-
            The outOfStockConfig is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br/>
        price:
          deprecated: true
          description: >-
            Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          example: 1200
          type: number
        scannableCodes:
          description: Codes, that identify the article
          items:
            type: string
          type: array
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        status:
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        stockAvailableUntil:
          $ref: '#/components/schemas/AvailableUntilDefinition'
        stockProperties:
          additionalProperties:
            $ref: '#/components/schemas/StockPropertyDefinition'
          description: >-
            Key-value pairs for stock properties of the requested items. Must be
            a subset of the listings defined stockProperties
          type: object
        targetingStrategy:
          description: >-
            Targeting strategy for this bulk upsert entry - determines how
            target facilities are specified.
          enum:
            - MULTI_SELECTOR
            - SINGLE_FACILITY
          example: SINGLE_FACILITY
          type: string
        tenantArticleId:
          description: This is a reference to an article Id
          example: '4711'
          minLength: 1
          type: string
        title:
          description: a title describing the article
          example: Adidas Superstar
          minLength: 1
          type: string
        version:
          description: >-
            Optional version of the facility. Must be provided for existing
            facilities.
          example: 1
          type: number
        weight:
          deprecated: true
          description: >-
            Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          example: 42
          minimum: 0
          type: number
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 0
          type: array
      required:
        - tenantArticleId
        - title
        - targetingStrategy
        - facility
      title: ListingForBulkUpsertByFacility
      type: object
      description: ListingForBulkUpsertByFacility
    ListingForBulkUpsertBySelector:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        attributes:
          items:
            $ref: '#/components/schemas/ListingAttributeItem'
          maxItems: 40
          type: array
        categoryRefs:
          description: References to categories the listing belongs to.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 10
          type: array
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          deprecated: true
          description: >-
            Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          example: EUR
          nullable: true
          type: string
        customAttributes:
          additionalProperties: true
          description: >-
            Attributes that can be added to the listing. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Please make sure that no
            authentication is required to fetch the image!
          example: https://example.com/resource
          type: string
        legal:
          $ref: '#/components/schemas/ListingLegal'
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        outOfStockBehaviourByContexts:
          description: >-
            The OutOfStockBehaviourByContexts is in Alpha status. For details,
            see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br/>
          items:
            $ref: '#/components/schemas/OutOfStockBehaviourByContext2'
          maxItems: 10
          minItems: 1
          type: array
        outOfStockConfig:
          allOf:
            - $ref: '#/components/schemas/OutOfStockConfig2'
          description: >-
            The outOfStockConfig is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br/>
        price:
          deprecated: true
          description: >-
            Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          example: 1200
          type: number
        scannableCodes:
          description: Codes, that identify the article
          items:
            type: string
          type: array
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        selector:
          description: >-
            Facility selectors for bulk operations. Add one or more selectors to
            specify the facilities for the listings.
          items:
            $ref: '#/components/schemas/ListingFacilitySelector'
          minItems: 1
          type: array
        status:
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        stockAvailableUntil:
          $ref: '#/components/schemas/AvailableUntilDefinition'
        stockProperties:
          additionalProperties:
            $ref: '#/components/schemas/StockPropertyDefinition'
          description: >-
            Key-value pairs for stock properties of the requested items. Must be
            a subset of the listings defined stockProperties
          type: object
        targetingStrategy:
          description: >-
            Targeting strategy for this bulk upsert entry - determines how
            target facilities are specified.
          enum:
            - MULTI_SELECTOR
            - SINGLE_FACILITY
          example: MULTI_SELECTOR
          type: string
        tenantArticleId:
          description: This is a reference to an article Id
          example: '4711'
          minLength: 1
          type: string
        title:
          description: a title describing the article
          example: Adidas Superstar
          minLength: 1
          type: string
        weight:
          deprecated: true
          description: >-
            Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes)
          example: 42
          minimum: 0
          type: number
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 0
          type: array
      required:
        - tenantArticleId
        - title
        - targetingStrategy
        - selector
      title: ListingForBulkUpsertBySelector
      type: object
      description: ListingForBulkUpsertBySelector
    ListingForCreation:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        attributes:
          items:
            $ref: '#/components/schemas/ListingAttributeItem'
          maxItems: 40
          type: array
        availabilityTimeframe:
          $ref: '#/components/schemas/AvailabilityTimeframe'
          deprecated: true
          description: >-
            @deprecated This property (for OutOfStockBehaviour.BACKORDER) is
            deprecated since 26th of February 2025.
        categoryRefs:
          description: References to categories the listing belongs to.
          items:
            type: string
          maxItems: 10
          type: array
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).
          example: EUR
          nullable: true
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the listing. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Please make sure that no
            authentication is required to fetch the image!
          type: string
        legal:
          $ref: '#/components/schemas/ListingLegal'
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        outOfStockBehaviourByContexts:
          description: >-
            The OutOfStockBehaviourByContexts is in Alpha status. For details
            please check the <a
            href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha"
            target="_blank">api-release-life-cycle documentation</a>.<br /><br
            />
          items:
            $ref: '#/components/schemas/OutOfStockBehaviourByContext'
          maxItems: 10
          minItems: 1
          type: array
        outOfStockConfig:
          $ref: '#/components/schemas/OutOfStockConfig'
          description: >-
            The outOfStockConfig is in Alpha status. For details please check
            the <a
            href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha"
            target="_blank">api-release-life-cycle documentation</a>.<br /><br
            />
        partialStocks:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 11th of September 2023.

            Use /api/stocks endpoints instead.
          items:
            $ref: '#/components/schemas/PartialStockForCreation'
          type: array
        price:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
          example: 1200
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/ListingRecordableAttributeForCreation'
          maxItems: 40
          type: array
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        stockAvailableUntil:
          $ref: '#/components/schemas/AvailableUntilDefinition'
        stockinformation:
          $ref: '#/components/schemas/StockInformationForCreation'
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 11th of September 2023.

            Use /api/stocks endpoints instead.
        stockProperties:
          additionalProperties:
            $ref: '#/components/schemas/StockPropertyDefinition'
          type: object
        tenantArticleId:
          description: This is a reference to an article Id
          example: '4711'
          minLength: 1
          type: string
        title:
          description: a title describing the article
          example: Adidas Superstar
          minLength: 1
          type: string
        weight:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Use attributes instead (see article attributes:
            https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
          minimum: 0
          type: number
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 0
          type: array
      required:
        - tenantArticleId
      type: object
      xml:
        name: ListingForCreation
      title: ListingForCreation
      description: ListingForCreation
    ListingForReplacement:
      allOf:
        - $ref: '#/components/schemas/ListingForCreation'
      properties:
        status:
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          example: 42
          format: int64
          type: integer
      type: object
      xml:
        name: ListingForReplacement
      title: ListingForReplacement
      description: ListingForReplacement
    ListingLegal:
      additionalProperties: false
      properties:
        hsCode:
          maxLength: 50
          type: string
      type: object
      title: ListingLegal
      description: ListingLegal
    ListingOutOfStockBehaviourEnumFilter:
      properties:
        eq:
          description: Search by outOfStockBehaviour
          enum:
            - NONE
            - BACKORDER
            - PREORDER
            - RESTOCK
            - PREORDER_AND_RESTOCK
          type: string
        in:
          description: Search by outOfStockBehaviour
          items:
            enum:
              - NONE
              - BACKORDER
              - PREORDER
              - RESTOCK
              - PREORDER_AND_RESTOCK
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by outOfStockBehaviour
          enum:
            - NONE
            - BACKORDER
            - PREORDER
            - RESTOCK
            - PREORDER_AND_RESTOCK
          type: string
      title: ListingOutOfStockBehaviourEnumFilter
      type: object
      description: ListingOutOfStockBehaviourEnumFilter
    ListingPaginatedResult:
      properties:
        listings:
          items:
            $ref: '#/components/schemas/Listing'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - listings
      title: ListingPaginatedResult
      type: object
      description: ListingPaginatedResult
    ListingPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyListing'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: ListingPatchActions
      title: ListingPatchActions
      description: ListingPatchActions
    ListingRecordableAttribute:
      additionalProperties: false
      properties:
        keyLocalized:
          $ref: '#/components/schemas/LocaleString'
        key:
          description: Calculated value from keyLocalized based on passed locale
          example: Serialnumber
          type: string
        recordingRule:
          description: Indicates whether the value has to be recorded or not
          enum:
            - OPTIONAL
            - MANDATORY
          example: MANDATORY
          type: string
        value:
          description: The value of the attribute
          example: Germany
          minLength: 1
          nullable: true
          type: string
      required:
        - keyLocalized
        - recordingRule
      title: ListingRecordableAttribute
      type: object
      description: ListingRecordableAttribute
    ListingRecordableAttributeForCreation:
      additionalProperties: false
      properties:
        keyLocalized:
          $ref: '#/components/schemas/LocaleString'
        recordingRule:
          description: Indicates whether the value has to be recorded or not
          enum:
            - OPTIONAL
            - MANDATORY
          example: MANDATORY
          type: string
        value:
          description: The value of the attribute
          example: Germany
          minLength: 1
          nullable: true
          type: string
      required:
        - keyLocalized
        - recordingRule
      title: ListingRecordableAttributeForCreation
      type: object
      description: ListingRecordableAttributeForCreation
    ListingSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ListingSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ListingSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ListingSearchPayload
      type: object
      description: ListingSearchPayload
    ListingSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ListingSearchQuery'
          maxItems: 500
          type: array
        availabilityTimeframe:
          allOf:
            - $ref: '#/components/schemas/ListingAvailabilityTimeframeFilter'
          description: Nested search by availabilityTimeframe
          example: 2026-06-17T12:00:00.000Z
        categoryRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by categoryRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        measurementUnitKey:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by measurementUnitKey
        or:
          items:
            $ref: '#/components/schemas/ListingSearchQuery'
          maxItems: 500
          type: array
        outOfStockBehaviour:
          allOf:
            - $ref: '#/components/schemas/ListingOutOfStockBehaviourEnumFilter'
          description: Search by outOfStockBehaviour
        price:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by price
        status:
          allOf:
            - $ref: '#/components/schemas/ListingStatusEnumEnumFilter'
          description: Search by status
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        weight:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by weight
        tags:
          allOf:
            - $ref: '#/components/schemas/ListingTagsListFilter'
          description: Nested list search by tags
      title: ListingSearchQuery
      type: object
      description: ListingSearchQuery
    ListingsForCreation:
      properties:
        listings:
          items:
            $ref: '#/components/schemas/ListingForCreation'
          minItems: 1
          type: array
      required:
        - listings
      type: object
      xml:
        name: ListingsForCreation
      title: ListingsForCreation
      description: ListingsForCreation
    ListingsForReplacement:
      properties:
        listings:
          items:
            $ref: '#/components/schemas/ListingForReplacement'
          maxItems: 500
          minItems: 1
          type: array
      required:
        - listings
      type: object
      xml:
        name: ListingsForReplacement
      title: ListingsForReplacement
      description: ListingsForReplacement
    ListingSort:
      properties:
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        tenantArticleId:
          enum:
            - ASC
            - DESC
          type: string
      title: ListingSort
      type: object
      description: ListingSort
    ListingStatusEnumEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - ACTIVE
              - INACTIVE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - ACTIVE
            - INACTIVE
          type: string
      title: ListingStatusEnumEnumFilter
      type: object
      description: ListingStatusEnumEnumFilter
    ListingTagsFilter:
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        value:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by value
      title: ListingTagsFilter
      type: object
      description: ListingTagsFilter
    ListingTagsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ListingTagsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ListingTagsListFilter
      type: object
      description: ListingTagsListFilter
    ListingWebHookEventPayload:
      properties:
        items:
          items:
            $ref: '#/components/schemas/InventoryListingEventPayload'
          type: array
      required:
        - items
      title: ListingWebHookEventPayload
      type: object
      description: ListingWebHookEventPayload
    LoadUnit:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        codes:
          description: List of codes
          items:
            type: string
          maxItems: 100
          type: array
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        description:
          type: string
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system. But it is not updatable via PUT request
          example: Esb20gpHBL94X5NdMp3C
          type: string
        iconUrl:
          type: string
        id:
          description: Unique identifier for the load unit
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        loadUnitLineItems:
          items:
            $ref: '#/components/schemas/LoadUnitLineItem'
          maxItems: 100
          type: array
        loadUnitTypeRef:
          deprecated: true
          description: Use operativeContainerTypeRef instead.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        name:
          type: string
        operativeContainerTypeRef:
          description: the reference to the operativeContainerType
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        operativeProcessRef:
          description: Reference to related operative process
          example: 019f5b8e-d580-767f-a28d-3fe569bd0064
          minLength: 1
          type: string
        pickJobRefs:
          description: List of corresponding pickjob Ids
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
          uniqueItems: true
        stackRef:
          description: the reference to the stackRef this loadUnit is part of
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        status:
          default: AVAILABLE
          description: >-
            The status of the load unit. It can be AVAILABLE or OBSOLETE. The
            status cannot be set from outside. When a load unit is created, it
            is automatically set to AVAILABLE. When a load unit is deleted, it
            is automatically set to OBSOLETE.
          enum:
            - AVAILABLE
            - OBSOLETE
          example: AVAILABLE
          type: string
        storageLocationRef:
          description: >-
            the reference to the storage location this load unit as been placed
            into
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        version:
          description: Version number for optimistic locking
          example: 1
          type: integer
        weightLimitInG:
          description: Maximal weight in gramm(gr) the loadunit can handle.
          minimum: 1
          type: number
      required:
        - id
        - lastModified
        - created
        - version
        - facilityRef
        - pickJobRefs
        - nameLocalized
        - status
      title: LoadUnit
      type: object
      description: LoadUnit
    LoadUnitAssignmentConfiguration:
      description: >-
        Who do the load units need to be assigned in pickJob (SingleOrderPick)
        and pickRun (MultiOrderPick)
      properties:
        pickJob:
          $ref: '#/components/schemas/LoadUnitAssignmentType'
        pickRun:
          $ref: '#/components/schemas/LoadUnitAssignmentType'
      required:
        - pickJob
        - pickRun
      type: object
      title: LoadUnitAssignmentConfiguration
    LoadUnitAssignmentType:
      description: Where do the load unit needs to be assigned?
      enum:
        - INACTIVE
        - AT_START
        - AT_END
        - DURING_PICKING
      example: AT_END
      type: string
      title: LoadUnitAssignmentType
    LoadUnitConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        maxCount:
          default: 20
          description: Max creatable count of load units per load unit type
          example: 20
          type: integer
      type: object
      title: LoadUnitConfiguration
      description: LoadUnitConfiguration
    LoadUnitDimensions:
      properties:
        heightInCm:
          description: The height of the container (in cm)
          example: 50
          type: number
        lengthInCm:
          description: The length of the container (in cm)
          example: 100
          type: number
        weightInG:
          description: The weight of the container (in g)
          example: 1700
          type: number
        widthInCm:
          description: The width of the container (in cm)
          example: 25
          type: number
      title: LoadUnitDimensions
      type: object
      description: LoadUnitDimensions
    LoadUnitForCreation:
      properties:
        codes:
          description: List of codes
          items:
            type: string
          maxItems: 100
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        loadUnitLineItems:
          items:
            $ref: '#/components/schemas/LoadUnitLineItemForCreation'
          maxItems: 100
          type: array
        loadUnitTypeRef:
          deprecated: true
          description: Use operativeContainerTypeRef instead.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        operativeContainerTypeRef:
          description: the reference to the operativeContainerType
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        pickJobRefs:
          description: List of corresponding pickjob Ids
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        stackRef:
          description: the reference to the stackRef this loadUnit is part of
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            the reference to the storage location this load unit as been placed
            into
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - pickJobRefs
      title: LoadUnitForCreation
      type: object
      description: LoadUnitForCreation
    LoadUnitLineItem:
      properties:
        article:
          $ref: '#/components/schemas/LoadUnitLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        globalLineItemId:
          deprecated: true
          description: Deprecated. Use globalLineItemIds instead.
          type: string
        globalLineItemIds:
          description: Global line item ids that refer to this line item
          items:
            type: string
          maxItems: 100
          type: array
        id:
          description: Unique identifier for the line item
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened. This can be used to restore the ‘pre-split’
            status.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: Customizable information about the lineItem that can be set during
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          maxItems: 100
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          maxItems: 100
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 1
          minimum: 0
          type: number
      required:
        - id
        - article
      title: LoadUnitLineItem
      type: object
      description: LoadUnitLineItem
    LoadUnitLineItemArticle:
      properties:
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        attributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 100
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          type: string
        tenantArticleId:
          type: string
        title:
          type: string
        weight:
          type: number
      required:
        - tenantArticleId
        - title
      title: LoadUnitLineItemArticle
      type: object
      description: LoadUnitLineItemArticle
    LoadUnitLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/LoadUnitLineItemArticle'
        customAttributes:
          type: object
        globalLineItemId:
          deprecated: true
          description: Deprecated. Use globalLineItemIds instead.
          type: string
        globalLineItemIds:
          description: Global line item ids that refer to this line item
          items:
            type: string
          maxItems: 100
          type: array
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 100
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          maxItems: 100
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 1
          minimum: 0
          type: number
      required:
        - article
      title: LoadUnitLineItemForCreation
      type: object
      description: LoadUnitLineItemForCreation
    LoadUnitLineItemUpdateRecordableAttributesActionParameter:
      properties:
        name:
          description: Update the recordable attributes of the line items of a load unit
          type: string
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          maxItems: 100
          type: array
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - version
        - recordableAttributes
      title: LoadUnitLineItemUpdateRecordableAttributesActionParameter
      type: object
      description: LoadUnitLineItemUpdateRecordableAttributesActionParameter
    LoadUnitPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ReplaceLoadUnitLineItems'
          maxItems: 100
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - actions
        - version
      title: LoadUnitPatchActions
      type: object
      description: LoadUnitPatchActions
    LoadUnits:
      properties:
        loadUnits:
          description: found load units matching the search parameters
          items:
            $ref: '#/components/schemas/LoadUnit'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      required:
        - loadUnits
        - total
      title: LoadUnits
      type: object
      description: LoadUnits
    LoadUnitsForCreation:
      properties:
        loadUnits:
          items:
            $ref: '#/components/schemas/LoadUnitForCreation'
          maxItems: 100
          minItems: 1
          type: array
      required:
        - loadUnits
      title: LoadUnitsForCreation
      type: object
      description: LoadUnitsForCreation
    LoadUnitType:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        description:
          type: string
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        iconUrl:
          type: string
        id:
          type: string
        lastModified:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        name:
          type: string
        priority:
          description: >-
            This value gives the priority in the respective loadUnitType. The
            lower the value the higher is the priority, e.g. priority 1 is
            higher than priority 10. The priority can be used to order
            loadUnityTypes
          example: 100
          format: int64
          maximum: 10000
          minimum: 1
          type: integer
        version:
          example: 1
          type: number
        weightLimitInG:
          description: Maximal weight in gramm(gr) the loadunit can handle.
          minimum: 1
          type: number
      required:
        - id
        - version
        - nameLocalized
      title: LoadUnitType
      type: object
      description: LoadUnitType
    LoadUnitTypeForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        icon:
          $ref: '#/components/schemas/NamedFile'
        priority:
          description: >-
            This value gives the priority in the respective loadUnitType. The
            lower the value the higher is the priority, e.g. priority 1 is
            higher than priority 10. The priority can be used to order
            loadUnityTypes
          example: 100
          format: int64
          maximum: 10000
          minimum: 1
          type: integer
        weightLimitInG:
          description: Maximal weight in gramm(gr) the loadunit can handle.
          minimum: 1
          type: number
      required:
        - nameLocalized
      title: LoadUnitTypeForCreation
      type: object
      description: LoadUnitTypeForCreation
    LoadUnitTypePatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyLoadUnitType'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - actions
      title: LoadUnitTypePatchActions
      type: object
      description: LoadUnitTypePatchActions
    LocaleConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        countryLanguageMapping:
          $ref: '#/components/schemas/CountryLanguageMapping'
        id:
          type: string
        locale:
          $ref: '#/components/schemas/SupportedLocale'
      required:
        - locale
      type: object
      title: LocaleConfiguration
      description: LocaleConfiguration
    LocaleString:
      additionalProperties:
        type: string
      description: >-
        Provides localized values. The key is the locale, the value is the
        translation.
        https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
      example:
        de_DE: Wert
        en_US: Value
        ru_RU: значение
      title: LocaleString
      type: object
    LocaleStringConstrained:
      properties: {}
      title: LocaleStringConstrained
      type: object
      description: LocaleStringConstrained
    LocalizedAvailableDecisionReason:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        context:
          items:
            $ref: '#/components/schemas/DecisionReasonContext'
          maxItems: 10
          minItems: 1
          type: array
        reason:
          description: Translated value from  reasonLocalized
          example: Item damaged
          type: string
      required:
        - reason
        - reasonLocalized
      title: LocalizedAvailableDecisionReason
      type: object
      description: LocalizedAvailableDecisionReason
    LocalizedAvailableItemCondition:
      properties:
        conditionLocalized:
          $ref: '#/components/schemas/LocaleString'
        condition:
          description: translated conditionsLocalized
          example: Damaged
          type: string
      required:
        - condition
        - conditionLocalized
      title: LocalizedAvailableItemCondition
      type: object
      description: LocalizedAvailableItemCondition
    LocalizedAvailableReturnReason:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        identifier:
          description: >-
            Small identifier to be displayed and printed. Allowed values are
            1-99 and A-Z. Needs to be unique respecting all other reasons. If
            not set, an ascending will be chosen automatically
          example: A
          type: string
        reason:
          description: translated reasonLocalized
          example: Damaged
          type: string
      required:
        - identifier
        - reason
        - reasonLocalized
      title: LocalizedAvailableReturnReason
      type: object
      description: LocalizedAvailableReturnReason
    LocalizedReturnConfiguration:
      properties:
        active:
          default: true
          deprecated: true
          description: >-
            Enable or disable legacy returns. Use returnTypeConfiguration
            instead
          example: true
          type: boolean
        allowTriggerRefund:
          default: false
          description: >-
            If true, a refund can be triggered. If false, the endpoints to
            trigger a refund are disabled.
          type: boolean
        availableDecisionReasons:
          items:
            $ref: '#/components/schemas/LocalizedAvailableDecisionReason'
          type: array
        availableItemConditions:
          items:
            $ref: '#/components/schemas/LocalizedAvailableItemCondition'
          type: array
        availableReturnReasons:
          items:
            $ref: '#/components/schemas/LocalizedAvailableReturnReason'
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        returnTypeConfiguration:
          $ref: '#/components/schemas/ReturnTypeConfiguration'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 1
          type: integer
      required:
        - active
        - version
      title: LocalizedReturnConfiguration
      type: object
      description: LocalizedReturnConfiguration
    LocalizedStringSearchFilter:
      properties:
        eq:
          maxLength: 256
          type: string
        in:
          items:
            maxLength: 256
            type: string
          maxItems: 25
          type: array
        like:
          description: Search by regex pattern
          maxLength: 256
          type: string
        notEq:
          maxLength: 256
          type: string
        notIn:
          items:
            maxLength: 256
            type: string
          maxItems: 25
          type: array
      title: LocalizedStringSearchFilter
      type: object
      description: LocalizedStringSearchFilter
    Location:
      properties:
        locationRef:
          description: The id of the location
          type: string
        scannableCodes:
          description: Represents barcodes that may be scanned at this location
          items:
            type: string
          type: array
      xml:
        name: Location
      title: Location
      description: Location
    LookupAttributeDefinitions:
      properties: {}
      title: LookupAttributeDefinitions
      type: object
      description: LookupAttributeDefinitions
    LookupRecord:
      properties:
        attributeDefinitions:
          allOf:
            - $ref: '#/components/schemas/LookupAttributeDefinitions'
          description: >-
            Map of attribute definitions that specify the type for each
            attribute.
        created:
          description: The date when the record was created.
          format: date-time
          type: string
        id:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        items:
          description: >-
            Collection of items in the lookup record, each containing attribute
            values.
          items:
            $ref: '#/components/schemas/LookupRecordItemStripped'
          type: array
        lastModified:
          description: The date when the record was last modified.
          format: date-time
          type: string
        tenantRecordId:
          description: Tenant-specific identifier for the lookup record.
          example: MY_RECORD_ID
          maxLength: 20
          minLength: 1
          type: string
        version:
          description: The version of the record.
          example: 1
          type: number
      required:
        - id
        - version
        - attributeDefinitions
        - items
      title: LookupRecord
      type: object
      description: LookupRecord
    LookupRecordForCreation:
      properties:
        attributeDefinitions:
          allOf:
            - $ref: '#/components/schemas/LookupAttributeDefinitions'
          description: >-
            Map of attribute definitions that specify the type for each
            attribute.
        items:
          description: >-
            Collection of items in the lookup record, each containing attribute
            values.
          items:
            $ref: '#/components/schemas/LookupRecordItemForCreation'
          type: array
        tenantRecordId:
          description: Tenant-specific identifier for the lookup record.
          example: MY_RECORD_ID
          maxLength: 20
          minLength: 1
          type: string
      required:
        - attributeDefinitions
        - items
      title: LookupRecordForCreation
      type: object
      description: LookupRecordForCreation
    LookupRecordForUpdate:
      properties:
        attributeDefinitions:
          allOf:
            - $ref: '#/components/schemas/LookupAttributeDefinitions'
          description: >-
            Map of attribute definitions that specify the type for each
            attribute.
        items:
          description: >-
            Collection of items in the lookup record, each containing attribute
            values.
          items:
            $ref: '#/components/schemas/LookupRecordItemForCreation'
          type: array
        tenantRecordId:
          description: Tenant-specific identifier for the lookup record.
          example: MY_RECORD_ID
          maxLength: 20
          minLength: 1
          type: string
        version:
          description: The version of the record.
          example: 1
          type: number
      required:
        - version
        - attributeDefinitions
        - items
      title: LookupRecordForUpdate
      type: object
      description: LookupRecordForUpdate
    LookupRecordItem:
      properties:
        id:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        recordRef:
          description: Reference to the parent lookup record.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantRecordId:
          description: Tenant-specific identifier for the lookup record.
          example: MY_RECORD_ID
          maxLength: 20
          minLength: 1
          type: string
        values:
          $ref: '#/components/schemas/LookupRecordItemValue'
          description: Array of attribute-value pairs for the lookup record item.
          items:
            type: string
      required:
        - recordRef
        - values
        - id
      title: LookupRecordItem
      type: object
      description: LookupRecordItem
    LookupRecordItemForCreation:
      properties:
        values:
          description: Array of attribute-value pairs for the lookup record item.
          items:
            $ref: '#/components/schemas/LookupRecordItemValue'
          type: array
      required:
        - values
      title: LookupRecordItemForCreation
      type: object
      description: LookupRecordItemForCreation
    LookupRecordItemPaginatedResult:
      properties:
        lookupRecordItems:
          items:
            $ref: '#/components/schemas/LookupRecordItem'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - lookupRecordItems
      title: LookupRecordItemPaginatedResult
      type: object
      description: LookupRecordItemPaginatedResult
    LookupRecordItemSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/LookupRecordItemSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: LookupRecordItemSearchPayload
      type: object
      description: LookupRecordItemSearchPayload
    LookupRecordItemSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/LookupRecordItemSearchQuery'
          maxItems: 500
          type: array
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/LookupRecordItemSearchQuery'
          maxItems: 500
          type: array
        recordRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by recordRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        tenantRecordId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantRecordId
          example: MY_RECORD_ID
        values:
          allOf:
            - $ref: '#/components/schemas/LookupRecordItemValuesListFilter'
          description: Nested list search by values
      title: LookupRecordItemSearchQuery
      type: object
      description: LookupRecordItemSearchQuery
    LookupRecordItemStripped:
      properties:
        id:
          description: Unique identifier for the lookup record item.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        values:
          description: Array of attribute-value pairs for the lookup record item.
          items:
            $ref: '#/components/schemas/LookupRecordItemValue'
          type: array
      required:
        - values
        - id
      title: LookupRecordItemStripped
      type: object
      description: LookupRecordItemStripped
    LookupRecordItemValue:
      properties:
        attributeId:
          description: Identifier of the attribute.
          maxLength: 100
          minLength: 1
          type: string
        attributeValue:
          anyOf:
            - maxLength: 150
              minLength: 1
              type: string
            - type: number
            - enum:
                - null
          description: Value of the attribute (can be string, number, or null).
      required:
        - attributeId
        - attributeValue
      title: LookupRecordItemValue
      type: object
      description: LookupRecordItemValue
    LookupRecordItemValuesFilter:
      properties:
        attributeId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by attributeId
        attributeValue:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by attributeValue
      title: LookupRecordItemValuesFilter
      type: object
      description: LookupRecordItemValuesFilter
    LookupRecordItemValuesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/LookupRecordItemValuesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: LookupRecordItemValuesListFilter
      type: object
      description: LookupRecordItemValuesListFilter
    ManagedFacility:
      allOf:
        - $ref: '#/components/schemas/Facility'
        - $ref: '#/components/schemas/ManagedFacilityForCreation'
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddress'
        configs:
          items:
            $ref: '#/components/schemas/LinkedConfiguration'
          type: array
      required:
        - status
        - address
        - name
      type: object
      xml:
        name: ManagedFacility
      title: ManagedFacility
      description: ManagedFacility
    ManagedFacilityForCreation:
      allOf:
        - $ref: '#/components/schemas/FacilityForCreation'
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddressForCreation'
        capacityEnabled:
          default: false
          description: >-
            Indicates that configured capacity limits for picking times are
            considered
          type: boolean
        capacityPlanningTimeframe:
          description: >-
            The range in days per facility which defines how many days in the
            future the capacity of the facility can be planned
          minimum: 1
          type: integer
        closingDays:
          description: >-
            Days of the year where the facility is closed and doesn't allows
            picking
          items:
            $ref: '#/components/schemas/ClosingDay'
          type: array
        contact:
          $ref: '#/components/schemas/FacilityContact'
        fulfillmentProcessBuffer:
          default: 240
          description: Duration in minutes until an order is processed
          example: '240'
          minimum: 0
          type: integer
        locationType:
          $ref: '#/components/schemas/FacilityLocationType'
        pickingMethods:
          description: Picking Methods supported by this facility.
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          type: array
        pickingTimes:
          $ref: '#/components/schemas/PickingTimes'
          description: >-
            Time ranges defining the picking times per weekday. No overlapping
            ranges are allowed
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        services:
          items:
            $ref: '#/components/schemas/FacilityService'
          type: array
      required:
        - name
        - address
      type: object
      xml:
        name: ManagedFacilityForCreation
      title: ManagedFacilityForCreation
      description: ManagedFacilityForCreation
    ManagedFacilityForModification:
      additionalProperties: false
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddressForCreation'
        capacityEnabled:
          description: >-
            Indicates that configured capacity limits for picking times are
            considered
          nullable: true
          type: boolean
        capacityPlanningTimeframe:
          description: >-
            The range in days per facility which defines how many days in the
            future the capacity of the facility can be planned
          minimum: 1
          nullable: true
          type: integer
        closingDays:
          description: >-
            Days of the year where the facility is closed and doesn't allows
            picking
          items:
            $ref: '#/components/schemas/ClosingDay'
          nullable: true
          type: array
        configs:
          items:
            $ref: '#/components/schemas/LinkedConfiguration'
          nullable: true
          type: array
        contact:
          allOf:
            - $ref: '#/components/schemas/FacilityContact'
          nullable: true
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the facility. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          nullable: true
          type: object
        fulfillmentProcessBuffer:
          description: Duration in minutes until an order is processed
          example: '240'
          minimum: 0
          nullable: true
          type: integer
        locationType:
          allOf:
            - $ref: '#/components/schemas/FacilityLocationType'
          nullable: true
          type: string
        name:
          example: Hamburg NW2
          type: string
        pickingMethods:
          description: Picking Methods supported by this facility.
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          nullable: true
          type: array
        pickingTimes:
          allOf:
            - $ref: '#/components/schemas/PickingTimes'
          nullable: true
          type: object
        scanningRule:
          allOf:
            - $ref: '#/components/schemas/ScanningRuleConfiguration'
          nullable: true
          type: object
        services:
          items:
            $ref: '#/components/schemas/FacilityService'
          nullable: true
          type: array
        status:
          $ref: '#/components/schemas/FacilityStatus'
        tenantFacilityId:
          description: The id of the facility in the tenants own system
          example: K12345
          nullable: true
          type: string
        type:
          $ref: '#/components/schemas/FacilityType'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          nullable: true
          type: array
      required:
        - type
        - version
      type: object
      xml:
        name: ManagedFacilityForModification
      title: ManagedFacilityForModification
      description: ManagedFacilityForModification
    ManagedFacilityForReplacement:
      additionalProperties: false
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddressForCreation'
        capacityEnabled:
          default: false
          description: >-
            Indicates that configured capacity limits for picking times are
            considered
          type: boolean
        capacityPlanningTimeframe:
          description: >-
            The range in days per facility which defines how many days in the
            future the capacity of the facility can be planned
          minimum: 1
          type: integer
        closingDays:
          description: >-
            Days of the year where the facility is closed and doesn't allows
            picking
          items:
            $ref: '#/components/schemas/ClosingDay'
          type: array
        configs:
          items:
            $ref: '#/components/schemas/LinkedConfiguration'
          type: array
        contact:
          $ref: '#/components/schemas/FacilityContact'
        customAttributes:
          description: >-
            Attributes that can be added to the facility. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        fulfillmentProcessBuffer:
          default: 240
          description: Duration in minutes until an order is processed
          example: '240'
          minimum: 0
          type: integer
        locationType:
          $ref: '#/components/schemas/FacilityLocationType'
        name:
          example: Hamburg NW2
          type: string
        pickingMethods:
          description: Picking Methods supported by this facility.
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          type: array
        pickingTimes:
          $ref: '#/components/schemas/PickingTimes'
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        services:
          items:
            $ref: '#/components/schemas/FacilityService'
          type: array
        status:
          $ref: '#/components/schemas/FacilityStatus'
        tenantFacilityId:
          description: The id of the facility in the tenants own system
          example: K12345
          type: string
        type:
          $ref: '#/components/schemas/FacilityType'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      discriminator:
        propertyName: type
      required:
        - version
        - type
        - status
        - name
        - address
        - locationType
        - fulfillmentProcessBuffer
        - capacityEnabled
      type: object
      xml:
        name: ManagedFacilityForReplacement
      title: ManagedFacilityForReplacement
      description: ManagedFacilityForReplacement
    MandatoryLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/LineItemArticle'
          description: Information about the lineItem
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: ID of the recordable attribute
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - id
        - article
        - quantity
      title: MandatoryLineItem
      type: object
      description: MandatoryLineItem
    MandatoryLineItemForCreation:
      properties:
        article:
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - article
        - quantity
      title: MandatoryLineItemForCreation
      type: object
      description: MandatoryLineItemForCreation
    MandatoryShippingArticleAttribute:
      properties:
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized description of this shipping article attribute
        category:
          description: The category of this shipping article attribute
          enum:
            - customs
            - dimensions
            - insurance
          type: string
        dataType:
          description: The data type of this shipping article attribute
          enum:
            - NUMBER
            - STRING
          type: string
        description:
          description: Description of this shipping article attribute
          type: string
        referencedField:
          description: The referenced field for this shipping article attribute
          enum:
            - attributes.weightPerUnit
            - attributes.hsCode
            - attributes.currency
            - attributes.valuePerUnit
            - attributes.countryOfManufacture
          type: string
      required:
        - referencedField
        - dataType
        - category
        - descriptionLocalized
      title: MandatoryShippingArticleAttribute
      type: object
      description: MandatoryShippingArticleAttribute
    MandatoryShippingAttribute:
      properties:
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized description of this shipping attribute
        dataType:
          description: The data type of this shipping attribute
          enum:
            - Number
            - String
            - Date
            - Boolean
          type: string
        description:
          description: Description of this shipping attribute
          type: string
        referencedField:
          description: >-
            - dimensions.weight: will be calculated from
            MandatoryShippingArticleAttribute.attributes.weightPerUnit if items
            with weightPerUnit is set on all items

            - productValue: will be calculated from
            MandatoryShippingArticleAttribute.attributes.pricePerUnit if items
            with pricePerUnit is set on all items
          enum:
            - dimensions.weight
            - productValue
            - pickUpInformation.startTime
            - pickUpInformation.endTime
            - services.BulkyGoods
            - services.Signature
            - services.AdultSignature
            - services.CustomerSignature
            - services.SaturdayDelivery
            - services.IdentityCheckPrivate
            - services.IdentityCheckCompany
            - services.AdditionalTransportInsurance
            - carrierInformation.shippingContainerNumber
            - services.NoNeighborDelivery
            - services.HandoverToRecipientOnly
            - services.IdentityAgeCheck18
          type: string
      title: MandatoryShippingAttribute
      type: object
      description: MandatoryShippingAttribute
    MandatoryShippingItemAttribute:
      properties:
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized description of this attribute
        dataType:
          description: The data type of this attribute
          enum:
            - Number
            - String
            - Date
            - Boolean
          type: string
        description:
          description: Description of this attribute
          type: string
        referencedField:
          deprecated: true
          description: >-
            Deprecated: description: article.title will be used instead,
            weightInGram: use
            MandatoryShippingArticleAttribute.attributes.weightPerUnit
          enum:
            - description
            - weightInGram
            - quantity
            - parcelItemValue.value
            - parcelItemValue.currency
            - countryOfManufacture
            - tenantArticleId
          type: string
      title: MandatoryShippingItemAttribute
      type: object
      description: MandatoryShippingItemAttribute
    ManualRerouteConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      deprecated: true
      description: >-
        @deprecated This config property is deprecated since 26/02/24. Use
        GlobalManualRerouteConfiguration instead.
      properties:
        active:
          type: boolean
        id:
          type: string
      required:
        - active
      type: object
      title: ManualRerouteConfiguration
    MeasurementUnit:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MeasurementUnitForCreation'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        abbreviation:
          description: Translated abbreviation of the measurement unit
          example: kg
          type: string
        id:
          example: c5300790-9477-475c-bd6d-98e5d61f6413
          type: string
        name:
          description: Translated name of the measurement unit
          example: kilogramm
          type: string
      required:
        - id
      type: object
      title: MeasurementUnit
      description: MeasurementUnit
    MeasurementUnitForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        abbreviationLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Abbreviation of the unit. Maximum 4 chars long.
          example:
            de_DE: kg
            en_US: kg
            ru_RU: кг
        key:
          description: Descriptor for the measurement unit
          example: kilogramm
          type: string
        requiresMeasurement:
          description: Indicates that the given unit need to be measured.
          example: true
          type: boolean
      required:
        - nameLocalized
        - abbreviationLocalized
        - key
      type: object
      title: MeasurementUnitForCreation
      description: MeasurementUnitForCreation
    MeasurementUnits:
      properties:
        measurementUnits:
          items:
            $ref: '#/components/schemas/MeasurementUnit'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: MeasurementUnits
      description: MeasurementUnits
    MeasurementValidation:
      properties:
        overPickHardTolerancePercentage:
          description: Allowed hard over pick deviation tolerance.
          example: 20
          minimum: 0
          type: number
        overPickSoftTolerancePercentage:
          description: Allowed soft over pick deviation tolerance.
          example: 15
          minimum: 0
          type: number
        shortPickHardTolerancePercentage:
          description: Allowed hard short pick deviation tolerance.
          example: 15
          maximum: 100
          minimum: 0
          type: number
        shortPickSoftTolerancePercentage:
          description: Allowed soft short pick deviation tolerance.
          example: 10
          maximum: 100
          minimum: 0
          type: number
      title: MeasurementValidation
      description: MeasurementValidation
    MergeDocumentsDocument:
      properties:
        documentId:
          description: id of the document from the passed document set
          type: string
        documentsSetRef:
          description: document set of the passed document
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - documentId
        - documentsSetRef
      title: MergeDocumentsDocument
      type: object
      description: MergeDocumentsDocument
    MergeDocumentsParameter:
      properties:
        documents:
          description: Documents that should be merged during this operation
          items:
            $ref: '#/components/schemas/MergeDocumentsDocument'
          maxItems: 50
          minItems: 1
          type: array
      required:
        - documents
      title: MergeDocumentsParameter
      type: object
      description: MergeDocumentsParameter
    MissingHandoverJobLineItem:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MissingHandoverJobLineItemForCreation'
      properties:
        id:
          type: string
      required:
        - id
      type: object
      title: MissingHandoverJobLineItem
      description: MissingHandoverJobLineItem
    MissingHandoverJobLineItemForCreation:
      additionalProperties: false
      properties:
        article:
          $ref: '#/components/schemas/HandoverLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        quantity:
          description: quantity of the specific item that is missing
          example: 1
          format: int64
          minimum: 1
          type: integer
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - quantity
        - article
      type: object
      title: MissingHandoverJobLineItemForCreation
      description: MissingHandoverJobLineItemForCreation
    ModifyAddress:
      properties:
        additionalAddressInfo:
          example: 'to care of: Mrs. Müller'
          type: string
        city:
          example: Langenfeld
          pattern: ^.+$
          type: string
        country:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the address. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        houseNumber:
          example: 42a
          pattern: ^.+$
          type: string
        phoneNumbers:
          items:
            properties:
              customAttributes:
                description: >-
                  Attributes that can be added to the phonenumber. These
                  attributes cannot be used within fulfillment processes, but it
                  could be useful to have the informations carried here.
                type: object
              label:
                description: >-
                  Can be used to give a description for the number, like
                  "private", "business number", etc.
                type: string
              type:
                enum:
                  - MOBILE
                  - PHONE
                type: string
              value:
                description: The number itself. We do not enforce any format (yet).
                type: string
            type: object
          maxItems: 500
          type: array
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        province:
          example: Nordrhein-Westfalen
          pattern: ^.+$
          type: string
        resolvedCoordinates:
          $ref: '#/components/schemas/Coordinates'
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      type: object
      title: ModifyAddress
      description: ModifyAddress
    ModifyCarrier:
      properties:
        action:
          description: Use value 'ModifyCarrier', because you want to modify a carrier
          enum:
            - ModifyCarrier
          example: ModifyCarrier
          type: string
        credentials:
          allOf:
            - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
          description: Credentials for the carrier
        defaultParcelHeightInCm:
          default: 10
          description: Default height in cm
          example: 10
          minimum: 1
          type: number
        defaultParcelLengthInCm:
          default: 25
          description: Default length in cm
          example: 25
          minimum: 1
          type: number
        defaultParcelWeightInGram:
          default: 1000
          description: Default weight for a parcel in gram
          example: 1000
          minimum: 1
          type: number
        defaultParcelWidthInCm:
          default: 35
          description: Default width in cm
          example: 35
          minimum: 1
          type: number
        deliveryType:
          description: Provided delivery of this CEP
          enum:
            - SAMEDAY
            - DELIVERY
          type: string
        lifecycle:
          description: >-
            Used to determine if a carrier is available for configuration. GA
            carriers are generally available and are covered by our SLA. BETA
            carriers are available, but subject to change and not covered by
            SLA. ALPHA carriers are not implemented completely, yet.
          enum:
            - GA
            - BETA
            - ALPHA
          type: string
        logoUrl:
          description: URL of the carrier logo
          example: https://example.com/resource
          minLength: 1
          type: string
        name:
          description: >-
            This is the well known name for a supported CEP partner. Can be
            adapted to the clients needs.
          type: string
        parcelLabelClassifications:
          description: Parcel label classifications for this carrier
          items:
            $ref: '#/components/schemas/ParcelLabelClassificationForCreation'
          type: array
        productValueNeeded:
          description: >-
            Setting to enable the Client to ask for the parcel product value
            while ordering a label. This information is mandatory for sending
            parcels between different countries (customs declaration)
          type: boolean
        status:
          description: It is taken into consideration for all carriers
          enum:
            - ACTIVE
            - INACTIVE
          type: string
      required:
        - action
      title: ModifyCarrier
      type: object
      description: ModifyCarrier
    ModifyCustomServiceAction:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        action:
          description: >-
            Use value 'ModifyCustomService', because you want to modify a custom
            service
          enum:
            - ModifyCustomService
          example: ModifyCustomService
          type: string
        executionTimeInMin:
          description: Time in minutes the custom service takes to be executed
          example: 100
          minimum: 0
          type: integer
        imageRefs:
          description: List of linked images for this custom service
          example:
            - https://my-image-host.com/images/custom-service-1.jpg
          items:
            type: string
          maxItems: 50
          minItems: 0
          type: array
        itemsRequired:
          description: >-
            Indicates whether items are required for executing a service job of
            this custom service
          enum:
            - MANDATORY
            - NONE
          example: OPTIONAL
          type: string
        itemsReturnable:
          description: >-
            Indicates if the items of the custom service are returnable after
            the custom service has been executed
          example: false
          type: boolean
        status:
          description: New status to set for the custom service
          enum:
            - ENABLED
            - DISABLED
            - INACTIVE
            - ACTIVE
          example: ACTIVE
          type: string
        tenantCustomServiceId:
          description: Tenant specific ID of the custom service to be modified
          example: MY-CUSTOM-SERVICE-1
          minLength: 1
          type: string
      required:
        - action
      title: ModifyCustomServiceAction
      type: object
      description: ModifyCustomServiceAction
    ModifyFacility:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyFacility', because you want to modify a
                facility
              enum:
                - ModifyFacility
              type: string
            address:
              $ref: '#/components/schemas/ModifyFacilityAddress'
            capacityEnabled:
              type: boolean
            capacityPlanningTimeframe:
              description: >-
                The range in days per facility which defines how many days in
                the future the capacity of the facility can be planned
              minimum: 1
              type: integer
            closingDays:
              description: >-
                Days of the year where the facility is closed and doesn't allows
                picking
              items:
                $ref: '#/components/schemas/ClosingDay'
              type: array
            contact:
              $ref: '#/components/schemas/FacilityContact'
            customAttributes:
              description: >-
                Attributes that can be added to the facility. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the informations carried here.
              type: object
            fulfillmentProcessBuffer:
              description: Duration in minutes until an order is processed
              example: '240'
              minimum: 0
              type: integer
            locationType:
              $ref: '#/components/schemas/FacilityLocationType'
            name:
              example: Hamburg NW2
              type: string
            operativeCosts:
              items:
                $ref: '#/components/schemas/FacilityOperativeCostForCreation'
              maxItems: 1
              type: array
            pickingMethods:
              description: Picking Methods supported by this facility.
              items:
                $ref: '#/components/schemas/PickingMethodEnum'
              type: array
            pickingTimes:
              $ref: '#/components/schemas/PickingTimes'
              description: >-
                Time ranges defining the picking times per weekday. No
                overlapping ranges are allowed
            scanningRule:
              $ref: '#/components/schemas/ScanningRuleConfiguration'
            services:
              items:
                properties:
                  type:
                    description: The description of the service this facility offers.
                    enum:
                      - SHIP_FROM_STORE
                      - PICKUP
                    type: string
                required:
                  - type
                type: object
              type: array
            status:
              description: >-
                The state of the facility. ONLINE means that this facility can
                process new orders and pickjobs, SUSPENDED means it cannot get
                new orders but is able to fulfill the current workload and
                OFFLINE means that it cannot fulfill any new or existing orders.
                Processes already running might be rescheduled to another
                facility depending on the preferences.
              enum:
                - ONLINE
                - SUSPENDED
                - OFFLINE
              type: string
            tenantFacilityId:
              description: The id of the facility in the tenants own system
              example: K12345
              type: string
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              minItems: 0
              type: array
          required:
            - action
          type: object
      xml:
        name: ModifyFacility
      title: ModifyFacility
      description: ModifyFacility
    ModifyFacilityAddress:
      allOf:
        - $ref: '#/components/schemas/ModifyAddress'
        - type: object
        - properties:
            companyName:
              example: Speedy Boxales Ltd.
              type: string
            emailAddresses:
              items:
                properties:
                  recipient:
                    description: >-
                      Human readable information who is the recipient for emails
                      sent to this address.
                    example: >-
                      'Mailinglist reaching all the employees', 'Marc Fulton,
                      Manager', etc.
                    type: string
                  value:
                    format: email
                    type: string
                required:
                  - value
                type: object
              type: array
          type: object
      title: ModifyFacilityAddress
      description: ModifyFacilityAddress
    ModifyFeature:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'ModifyFeature', because you want to modify a Feature
              enum:
                - ModifyFeature
              type: string
            status:
              $ref: '#/components/schemas/FeatureStatus'
              description: The state of the feature we want to change.
          required:
            - action
            - status
          type: object
      xml:
        name: ModifyFeature
      title: ModifyFeature
      description: ModifyFeature
    ModifyFenceAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: Use value 'ModifyFence', because you want to modify a fence.
              enum:
                - ModifyFence
              type: string
            active:
              type: boolean
            activeMode:
              $ref: '#/components/schemas/FenceMode'
            id:
              type: string
          required:
            - action
            - id
          type: object
      description: Action to Modify a Fence.
      title: ModifyFenceAction
      xml:
        name: ModifyFenceAction
    ModifyGlobalRoutingConfigurationAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyGlobalRoutingConfiguration', because you want
                to modify global routing configuration.
              enum:
                - ModifyGlobalRoutingConfiguration
              type: string
            defaultPrice:
              default: 10
              description: >-
                Default price which is used if no price exists in order or
                listings
              type: number
            fallbackFacilityConfiguration:
              $ref: '#/components/schemas/FallbackFacilityConfigurationForPatch'
            manualRerouteConfiguration:
              $ref: '#/components/schemas/GlobalManualRerouteConfiguration'
            routingTimeout:
              default: 8
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated Default amount of hours after which a
                routing plan is marked not routable. This field is deprecated in
                favour of stopRoutingAttemptsAfterTime
              type: number
            stopRoutingAttemptsAfterTime:
              default: PT8H
              description: >-
                Default amount of time in ISO 8601 duration format after which a
                routing plan is marked not routable. The duration need to be a
                multiple of 60 seconds.
              pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        @deprecated use RoutingStrategy configuration actions instead 'Action to
        Modify the Global Routing Configuration.'
      title: ModifyGlobalRoutingConfigurationAction
    ModifyHandoverjob:
      additionalProperties: false
      description: Action to modify a HandoverJob.
      properties:
        action:
          $ref: '#/components/schemas/ModifyHandoverjobActionEnum'
        customAttributes:
          description: >-
            Attributes that can be added to the handoverJob. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        status:
          $ref: '#/components/schemas/HandoverjobStatus'
      required:
        - action
      title: ModifyHandoverjobAction
      type: object
      xml:
        name: ModifyHandoverjob
    ModifyHandoverjobActionEnum:
      enum:
        - ModifyHandoverjob
      type: string
      title: ModifyHandoverjobActionEnum
      description: ModifyHandoverjobActionEnum
    ModifyListing:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            titleLocalized:
              $ref: '#/components/schemas/LocaleString'
            action:
              description: Use value 'ModifyListing', because you want to modify a listing
              enum:
                - ModifyListing
              type: string
            attributes:
              description: The attributes of this listing
              items:
                $ref: '#/components/schemas/ListingAttributeItem'
              maxItems: 40
              type: array
            availabilityTimeframe:
              $ref: '#/components/schemas/AvailabilityTimeframe'
              deprecated: true
              description: >-
                @deprecated This property (for OutOfStockBehaviour.BACKORDER) is
                deprecated since 26th of February 2025.
            categoryRefs:
              description: References to categories the listing belongs to.
              items:
                type: string
              maxItems: 10
              type: array
            currency:
              allOf:
                - $ref: '#/components/schemas/CurrencyCode'
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Use attributes instead (see article attributes:
                https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes).
              example: EUR
              nullable: true
              type: string
            customAttributes:
              description: >-
                Attributes that can be added to the listing. These attributes
                **cannot** be used within fulfillment processes, but enable you
                to attach custom data from your systems to fulfillmenttools
                entities.
              nullable: true
              type: object
            imageUrl:
              description: >-
                A web link to a picture of this article. Please make sure that
                no authentication is required to fetch the image!
              type: string
            legal:
              $ref: '#/components/schemas/ListingLegal'
            measurementUnitKey:
              example: kg
              nullable: true
              type: string
            outOfStockBehaviour:
              $ref: '#/components/schemas/OutOfStockBehaviour'
            outOfStockConfig:
              $ref: '#/components/schemas/OutOfStockConfig'
              description: >-
                The outOfStockConfig is in Alpha status. For details please
                check the <a
                href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha"
                target="_blank">api-release-life-cycle documentation</a>.<br
                /><br />
            price:
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Use attributes instead (see article attributes:
                https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
              example: 1200
              type: number
            recordableAttributes:
              description: >-
                Customizable information about the lineItem that can be set
                during the process.
              items:
                $ref: '#/components/schemas/ListingRecordableAttributeForCreation'
              maxItems: 40
              type: array
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
            scanningRule:
              $ref: '#/components/schemas/ScanningRuleConfiguration'
            status:
              description: The status indicates if a listing is available or not
              enum:
                - ACTIVE
                - INACTIVE
              type: string
            stockAvailableUntil:
              $ref: '#/components/schemas/AvailableUntilDefinition'
            stockinformation:
              $ref: '#/components/schemas/StockInformationForCreation'
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 11th of
                September 2023. Use /api/stocks endpoints instead.
            stockProperties:
              additionalProperties:
                $ref: '#/components/schemas/StockPropertyDefinition'
              nullable: true
              type: object
            subtitle:
              description: a subtitle describing the article
              example: 44 2/3
              type: string
            title:
              description: a title describing the article
              example: Adidas Superstar
              type: string
            weight:
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Use attributes instead (see article attributes:
                https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes)
              type: number
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              minItems: 0
              type: array
          required:
            - action
          type: object
      xml:
        name: ModifyListing
      title: ModifyListing
      description: ModifyListing
    ModifyListingReactivationAfter:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyListingReactivationAfter', if you want to
                modify the listingReactivationAfter of a facility
              enum:
                - ModifyListingReactivationAfter
              type: string
            listingReactivationAfter:
              properties:
                active:
                  default: true
                  description: The disabling of listings is enabled or disabled.
                  type: boolean
                value:
                  default: 24
                  description: >-
                    Time in hours that has to pass for a deactivated listing
                    (e.g. due to manual deactivation or as a result of a
                    shortpick ) to be become active again.
                  type: number
              type: object
          required:
            - action
          type: object
      description: Action to modify the reactivationAfter property of a Listing.
      title: ModifyListingReactivationAfterAction
      xml:
        name: ModifyListingReactivationAfter
    ModifyLoadUnitType:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        action:
          description: Use value, because you want to modify a LoadUnitType
          enum:
            - ModifyLoadUnitType
          type: string
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        priority:
          description: >-
            This value gives the priority in the respective loadUnitType. The
            lower the value the higher is the priority, e.g. priority 1 is
            higher than priority 10. The priority can be used to order
            loadUnityTypes
          example: 100
          format: int64
          maximum: 10000
          minimum: 1
          type: integer
        weightLimitInG:
          description: Maximal weight in gramm(gr) the loadunit can handle.
          minimum: 1
          type: number
      required:
        - action
      title: ModifyLoadUnitType
      type: object
      description: ModifyLoadUnitType
    ModifyMeAction:
      properties:
        action:
          description: The type of action to perform
          enum:
            - ModifyMe
          type: string
        firstname:
          description: The new firstname of the user
          example: Phil
          type: string
        lastname:
          description: The new lastname of the user
          example: Bison
          type: string
        locale:
          $ref: '#/components/schemas/SupportedLocale'
      required:
        - action
      title: ModifyMeAction
      type: object
      description: ModifyMeAction
    ModifyMyCredentialsAction:
      properties:
        action:
          description: The type of action to perform
          enum:
            - ModifyCredentials
          type: string
        currentPassword:
          description: Current password for verification (required)
          example: currentPassword123
          type: string
        email:
          description: New email address (optional)
          example: newemail@example.com
          type: string
        password:
          description: New password (optional)
          example: newSecurePassword456
          type: string
      required:
        - currentPassword
        - action
      title: ModifyMyCredentialsAction
      type: object
      description: ModifyMyCredentialsAction
    ModifyOrderSplitAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyOrderSplit', because you want to modify the
                configuration for the an order split.
              enum:
                - ModifyOrderSplit
              type: string
            active:
              default: false
              type: boolean
            activeForSameDay:
              default: false
              type: boolean
            fixedCountConfiguration:
              $ref: '#/components/schemas/FixedCountConfiguration'
            orderSplitType:
              $ref: '#/components/schemas/OrderSplitType'
            shouldUseWaitingRoomForPreBackOrderItems:
              default: false
              type: boolean
          required:
            - action
          type: object
      description: Action to Modify the Order Split Configuration.
      title: ModifyOrderSplitAction
      xml:
        name: ModifyOrderSplitAction
    ModifyPackingContainerType:
      additionalProperties: false
      description: Action to a modify the type of a packing container.
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        action:
          description: >-
            Use value 'ModifyPackingContainerType', because you want to modify a
            PackingContainerType
          enum:
            - ModifyPackingContainerType
          type: string
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        priority:
          description: >-
            This value gives the priority in the respective
            packingContainerType. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10. The priority
            can be used to order PackingContainerTypes.
          example: 100
          format: int32
          maximum: 10000
          minimum: 1
          type: integer
        weightLimitInG:
          description: 'Maximal weight in gramm(gr) the container can be loaded with. '
          example: 2500
          minimum: 1
          type: number
      required:
        - action
      title: ModifyPackingContainerType
      type: object
      xml:
        name: ModifyPackingContainerType
    ModifyPackingContainerTypeIcon:
      additionalProperties: false
      description: Action to a modify the type icon of a packing container.
      properties:
        action:
          description: >-
            Use value 'ModifyPackingContainerTypeIcon', because you want to
            modify a PackingContainerTypes icon
          enum:
            - ModifyPackingContainerTypeIcon
          type: string
        content:
          description: Content of the icon as base64 string
          type: string
        name:
          description: icons filename
          type: string
      required:
        - action
        - name
        - content
      title: ModifyPackingContainerTypeIcon
      type: object
      xml:
        name: ModifyPackingContainerTypeIcon
    ModifyPackJob:
      additionalProperties: false
      description: Action to modify a PackJob
      properties:
        action:
          description: Use value 'ModifyPackJob', because you want to modify a packjob
          enum:
            - ModifyPackJob
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the line item. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        status:
          $ref: '#/components/schemas/PackJobStatus'
      required:
        - action
      title: ModifyPackJob
      type: object
      xml:
        name: ModifyPackJob
    ModifyPackLineItem:
      additionalProperties: false
      description: Action to modify a PackLineItem of a PackJob
      properties:
        action:
          description: >-
            Use value 'ModifyPackLineItem', because you want to modify a
            packjobs lineItem
          enum:
            - ModifyPackLineItem
          type: string
        id:
          description: references the id of the packLineItem of a packJob
          type: string
        packed:
          description: >-
            The amount of articles that were packed for this packline. Can't be
            more than picked before.
          example: 20
          format: int64
          minimum: 0
          type: integer
      required:
        - action
        - id
      title: ModifyPackLineItem
      type: object
      xml:
        name: ModifyPackLineItem
    ModifyParcel:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'ModifyParcel', because you want to modify a Parcel
              enum:
                - ModifyParcel
              type: string
            carrierInformation:
              $ref: '#/components/schemas/ParcelCarrierInformation'
            carrierProduct:
              description: Only changable on status OPEN or FAILED of the existing Parcel
              nullable: true
              type: string
            customAttributes:
              type: object
            customProductValue:
              description: >-
                Set this value if you want to overwrite the calculated product
                value of the parcel.
              example: 12.5
              type: number
            dimensions:
              $ref: '#/components/schemas/ParcelDimensions'
            pickUpInformation:
              $ref: '#/components/schemas/ParcelPickUpInformation'
            productValue:
              description: >-
                Monetary value of all goods in this parcel. Needed for sending
                cross border packages (customs) To be interpreted as money in
                the currency given under paymentInformation.currency
              example: 12.5
              nullable: true
              type: number
            result:
              $ref: '#/components/schemas/ParcelResult'
            services:
              $ref: '#/components/schemas/ParcelServices'
            status:
              $ref: '#/components/schemas/ParcelStatus'
            tenantParcelId:
              type: string
          required:
            - action
          type: object
      description: Modify Parcel Action.
      title: ModifyParcelAction
      xml:
        name: ModifyParcel
    ModifyParcelLoadUnit:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyParcelLoadUnit', because you want to modify
                loadunitRefs in Parcel
              enum:
                - ModifyParcelLoadUnit
              type: string
            loadUnitRefs:
              items:
                type: string
              type: array
          required:
            - action
            - loadUnitRefs
          type: object
      description: Modify Parcels of a LoadUnit.
      title: ModifyParcelLoadUnitsAction
      xml:
        name: ModifyParcelLoadUnit
    ModifyPartialStock:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyPartialStock', because you want to modify a
                partial stock
              enum:
                - ModifyPartialStock
              type: string
            partialStocks:
              items:
                $ref: '#/components/schemas/PartialStockForCreation'
              minItems: 0
              type: array
          required:
            - action
          type: object
      xml:
        name: ModifyPartialStock
      title: ModifyPartialStock
      description: ModifyPartialStock
    ModifyPickJob:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: Use value 'ModifyPickJob', because you want to modify a pickjob
              enum:
                - ModifyPickJob
              type: string
            customAttributes:
              description: >-
                Attributes that can be added to the pickJob. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the informations carried here.
              type: object
            paymentInformation:
              $ref: '#/components/schemas/PaymentInformation'
            preferredPickingMethods:
              description: Preferred way of picking a given pickJob.
              items:
                $ref: '#/components/schemas/PickingMethodEnum'
              type: array
            status:
              $ref: '#/components/schemas/PickJobStatusUnprotected'
          required:
            - action
          type: object
      description: Action to modify a PickJob.
      title: ModifyPickJob
      xml:
        name: ModifyPickJob
    ModifyPickJobLastEditor:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyPickJobLastEditor' to set the last editor to
                your user and therefor take over the pickjob.
              enum:
                - ModifyPickJobLastEditor
              type: string
          required:
            - action
          type: object
      description: Action to modify the last editor of a PickJob.
      title: ModifyPickJobLastEditor
      xml:
        name: ModifyPickJobLastEditor
    ModifyPickJobLineItemsActionEnum:
      enum:
        - MODIFY_PICK_JOB_LINE_ITEMS
      type: string
      title: ModifyPickJobLineItemsActionEnum
      description: ModifyPickJobLineItemsActionEnum
    ModifyPickLineItem:
      allOf:
        - additionalProperties: false
          properties:
            shortPickReasonLocalized:
              $ref: '#/components/schemas/LocaleString'
            action:
              description: >-
                Use value 'ModifyPickLineItem', because you want to modify a
                pick line item
              enum:
                - ModifyPickLineItem
              type: string
            customAttributes:
              description: >-
                Attributes that can be added to the pick ine item. These
                attributes cannot be used within fulfillment processes, but it
                could be useful to have the informations carried here.
              type: object
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            partialStockLocations:
              items:
                $ref: >-
                  #/components/schemas/PickJobLineItemPartialStockLocationForUpdate
            picked:
              description: The amount of articles that were picked for this pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            pickedAt:
              description: Date when the line has been picked.
              example: 2024-02-03T08:45:51.525Z
              format: date-time
              type: string
            scannedCodes:
              description: Scanned Codes of the given picked line item
              items:
                $ref: '#/components/schemas/PickLineItemScannedCode'
              minItems: 0
            secondaryPicked:
              type: integer
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            stockEmptied:
              example: true
              type: boolean
            substituteLineItems:
              description: >-
                This part of the API is in Beta status. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />
              items:
                $ref: '#/components/schemas/SubstituteLineItemForUpsert'
              type: array
              x-badges:
                - color: orange
                  label: BETA
          required:
            - id
            - action
          type: object
      description: Action to modify a picklineitem of a PickJob.
      title: ModifyPickLineItem
      xml:
        name: ModifyPickLineItem
    ModifyPickLineItemsActionParameter:
      additionalProperties: false
      description: Action to modify picklineItems of a Pickjob.
      properties:
        name:
          $ref: '#/components/schemas/ModifyPickJobLineItemsActionEnum'
        pickJobLineItemUpdates:
          items:
            $ref: '#/components/schemas/PickLineItemUpdate'
          minItems: 1
          type: array
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - pickJobLineItemUpdates
      title: ModifyPickLineItemsActionParameter
      type: object
    ModifyPickRunLineItem:
      allOf:
        - properties:
            action:
              description: >-
                Use value 'ModifyPickRunLineItem', because you want to modify a
                pick line item
              enum:
                - ModifyPickRunLineItem
              type: string
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            partialStockLocations:
              items:
                $ref: >-
                  #/components/schemas/PickJobLineItemPartialStockLocationForUpdate
            picked:
              description: The amount of articles that were picked for this pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            secondaryPicked:
              description: >-
                The secondary amount of articles that were picked for this
                pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            shortPickReason:
              $ref: '#/components/schemas/ShortPickReasonForUpsert'
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
          required:
            - id
            - action
          type: object
      description: Action to modify a lineitem of a pickrun
      title: ModifyPickRunLineItem
      xml:
        name: ModifyPickRunLineItem
    ModifyPrioritizationAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyPrioritization', because you want to modify
                prioritization.
              enum:
                - ModifyPrioritization
              type: string
            active:
              type: boolean
            id:
              type: string
            name:
              type: string
          required:
            - action
            - id
          type: object
      description: Action to Modify the Prioritization Configuration.
      title: ModifyPrioritizationAction
      xml:
        name: ModifyPrioritizationAction
    ModifyRatingAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: Use value 'ModifyRating', because you want to modify a rating.
              enum:
                - ModifyRating
              type: string
            active:
              type: boolean
            description:
              type: string
            id:
              type: string
            maxPenalty:
              example: 100
              minimum: 0
              type: number
            name:
              type: string
          required:
            - action
            - id
          type: object
      description: Action to Modify a Rating.
      title: ModifyRatingAction
      xml:
        name: ModifyRatingAction
    ModifyRestowItemAction:
      additionalProperties: false
      description: Action to modify a restow item.
      properties:
        action:
          description: >-
            Use value 'ModifyRestowItem', because you want to modify a restow
            item
          enum:
            - ModifyRestowItem
          type: string
        location:
          $ref: '#/components/schemas/Location'
        restowed:
          default: false
          description: Indicates if the restowItem has been restowed
          example: true
          type: boolean
      required:
        - action
        - restowed
      title: ModifyRestowItemAction
      type: object
    ModifyRetainedOfflineStock:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated Concept depreated. Use safety stock instead.
              enum:
                - ModifyRetainedOfflineStock
              type: string
            active:
              description: The retained Offline Stock is enabled or disabled.
              type: boolean
            value:
              default: 0.2
              description: >-
                The overall percentage of stock that should be reserved to
                offline clients.
              example: 0.15
              maximum: 1
              minimum: 0.01
              type: number
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Concept depreated. Use safety stock instead.
      title: ModifyRetainedOfflineStockAction
      xml:
        name: ModifyRetainedOfflineStock
    ModifyRoutingPlanAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyRoutingPlan', because you want to modify a
                routing plan
              enum:
                - ModifyRoutingPlan
              type: string
            facilityRef:
              description: >-
                The id of the facility reference. The given ID has to be present
                in the system.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            status:
              $ref: '#/components/schemas/RoutingPlanStatus'
          required:
            - action
          type: object
      xml:
        name: ModifyRoutingPlanAction
      title: ModifyRoutingPlanAction
      description: ModifyRoutingPlanAction
    ModifyShipment:
      allOf:
        - additionalProperties: false
          properties:
            action:
              $ref: '#/components/schemas/ModifyShipmentActionEnum'
            carrierProduct:
              description: Desired product of given carrier to choose when ordering a label
              example: EXPRESS
              type: string
            carrierRef:
              description: >-
                The reference to the carrier for which the shipment is assigned
                to
              example: ca525716-7208-4a63-a2a6-11274eb37f67-0
              type: string
            paymentInformation:
              $ref: '#/components/schemas/PaymentInformation'
            pickJobRef:
              description: >-
                The reference to the pickjob for which the shipment is assigned
                to
              example: ca525716-7208-4a63-a2a6-11274eb37f67-0
              type: string
            status:
              $ref: '#/components/schemas/ShipmentStatus'
            targetAddress:
              $ref: '#/components/schemas/ConsumerAddress'
          required:
            - action
          type: object
      xml:
        name: ModifyShipment
      title: ModifyShipment
      description: ModifyShipment
    ModifyShipmentActionEnum:
      description: Use value 'ModifyShipment', because you want to modify a shipment
      enum:
        - ModifyShipment
      type: string
      title: ModifyShipmentActionEnum
    ModifyShortpick:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyShortpick', if you want to modify the
                ModifyShortPick of a facility
              enum:
                - ModifyShortpick
              type: string
            active:
              default: true
              description: Inventory adjustment in the case of insufficient order picking
              type: boolean
          required:
            - action
          type: object
      description: Modify Shortpick Action.
      title: ModifyShortpick
      xml:
        name: ModifyShortpick
    ModifyStorageLocationAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyStorageLocation', because you want to modify a
                storage location
              enum:
                - ModifyStorageLocation
              type: string
            customAttributes:
              description: >-
                Attributes that can be added to the storage location. These
                attributes cannot be used within fulfillment processes, but it
                could be useful to have the informations carried here.
              type: object
            information:
              description: >-
                A free text information about this storage location, max length
                1024
              maxLength: 1024
              type: string
            name:
              description: The name of this storage location
              maxLength: 15
              type: string
            runningSequences:
              description: The Sequence item/s of this location
              items:
                $ref: '#/components/schemas/StorageLocationSequenceItem'
              maxItems: 10
              type: array
            scannableCodes:
              description: Barcodes representing this storage location
              items:
                type: string
              maxItems: 5
              type: array
            tenantLocationId:
              description: The internal tenant id for this location
              type: string
            traitConfig:
              $ref: '#/components/schemas/StorageLocationTraitConfig'
            traits:
              deprecated: true
              description: >-
                The traits of this storage location. Do not use this to write
                traits, use traitConfig instead.
              items:
                $ref: '#/components/schemas/StorageLocationTrait'
              type: array
            type:
              $ref: '#/components/schemas/StorageLocationType'
            zoneRef:
              description: The id of the Zone to which this storage location belongs.
              example: Esb20gpHBL94X5NdMp3C
              type: string
          required:
            - action
          type: object
      xml:
        name: ModifyStorageLocationAction
      title: ModifyStorageLocationAction
      description: ModifyStorageLocationAction
    ModifyStowLineItemsAction:
      description: >-
        MODIFY_STOW_LINE_ITEMS targets specific stowJob.stowLineItems by ID.
        Each targeted entry is partially updated: provided fields are completely
        replaced, while unspecified fields remain unchanged. New entries can be
        added by omitting the ID field.
      properties:
        name:
          description: The name of the action that should be performed
          enum:
            - MODIFY_STOW_LINE_ITEMS
          type: string
        stowLineItems:
          items:
            $ref: '#/components/schemas/StowLineItemForUpdate'
          type: array
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
        - stowLineItems
      title: ModifyStowLineItemsAction
      type: object
    ModifyTimingModeAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyTimingMode', because you want to modify a
                timing mode.
              enum:
                - ModifyTimingMode
              type: string
            timingMode:
              $ref: '#/components/schemas/RoutingConfigurationTiming'
          required:
            - action
          type: object
      description: Action to Modify the Timing Mode.
      title: ModifyTimingModeAction
      xml:
        name: ModifyTimingModeAction
    ModifyUserAction:
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/UserActionEnum'
          description: The type of action to perform
        assignedFacilities:
          deprecated: true
          description: >-
            Deprecated: Use assignedRoles with contextLimitation of type
            FACILITY instead
          items:
            $ref: '#/components/schemas/UserAssignedFacilityForCreation'
          type: array
        assignedRoles:
          description: The new roles of the user
          items:
            $ref: '#/components/schemas/AssignedRoles'
          maxItems: 100
          type: array
        customAttributes:
          description: The new custom attributes of the user
          nullable: true
          type: object
        email:
          description: The changed email of the user
          example: phil.bison@fulfillmenttools.com
          type: string
        firstname:
          description: The new firstname of the user
          example: Phil
          type: string
        lastname:
          description: The new lastname of the user
          example: Bison
          type: string
        locale:
          $ref: '#/components/schemas/SupportedLocale'
        password:
          description: The new password of the user
          type: string
        roles:
          deprecated: true
          description: 'Deprecated: Use assignedRoles instead'
          items:
            $ref: '#/components/schemas/UserRole'
          type: array
      required:
        - action
      title: ModifyUserAction
      type: object
      description: ModifyUserAction
    ModifyUserPersonalData:
      properties:
        firstname:
          description: The new firstname of the user
          example: Phil
          type: string
        lastname:
          description: The new lastname of the user
          example: Bison
          type: string
        locale:
          $ref: '#/components/schemas/SupportedLocale'
      title: ModifyUserPersonalData
      type: object
      description: ModifyUserPersonalData
    ModuleEntity:
      enum:
        - ORDER
        - ROUTING_PLAN
        - PICK_JOB
        - PACK_JOB
        - SHIPMENT
        - HANDOVER_JOB
        - SERVICE_JOB
        - ITEM_RETURN_JOB
        - PARCEL
        - RESERVATION
        - PARCEL_INFORMATION
        - LABEL
        - TRACKING_INFORMATION
      type: string
      title: ModuleEntity
      description: ModuleEntity
    ModuleEntityStatus:
      enum:
        - PENDING
        - CREATED
        - IN_PROGRESS
        - STUCK
        - FINISHED
        - CANCELED
        - OBSOLETE
      type: string
      title: ModuleEntityStatus
      description: ModuleEntityStatus
    ModuleEntityStatusHistoryItem:
      properties:
        created:
          format: date-time
          type: string
        entityRef:
          type: string
        facilityRef:
          type: string
        moduleEntity:
          $ref: '#/components/schemas/ModuleEntity'
        status:
          $ref: '#/components/schemas/ModuleEntityStatus'
        subStatus:
          $ref: '#/components/schemas/ProcessSubStatus'
      required:
        - moduleEntity
        - status
        - entityRef
        - created
      type: object
      title: ModuleEntityStatusHistoryItem
      description: ModuleEntityStatusHistoryItem
    ModuleStatus:
      enum:
        - PENDING
        - CREATED
        - IN_PROGRESS
        - STUCK
        - FINISHED
        - INCOMPLETE
        - CANCELED
        - OBSOLETE
      type: string
      title: ModuleStatus
      description: ModuleStatus
    ModuleStatusItem:
      properties:
        module:
          $ref: '#/components/schemas/ModuleType'
        status:
          $ref: '#/components/schemas/ModuleStatus'
        subStatuses:
          items:
            $ref: '#/components/schemas/ProcessSubStatus'
          nullable: true
          type: array
      required:
        - module
        - status
      type: object
      title: ModuleStatusItem
      description: ModuleStatusItem
    ModuleType:
      enum:
        - PICKING
        - ROUTING
        - PACKING
        - SHIPMENT
        - HANDOVER
        - RETURN
        - SERVICE_JOB
        - RESERVATION
        - ORDER
        - SHIPPING
      type: string
      title: ModuleType
      description: ModuleType
    MonetaryValue:
      properties:
        currency:
          description: ISO 4217 currency code
          enum:
            - AED
            - AFN
            - ALL
            - AMD
            - ANG
            - AOA
            - ARS
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - BMD
            - BND
            - BOB
            - BOV
            - BRL
            - BSD
            - BTN
            - BWP
            - BYN
            - BZD
            - CAD
            - CDF
            - CHE
            - CHF
            - CHW
            - CLF
            - CLP
            - CNY
            - COP
            - COU
            - CRC
            - CUC
            - CUP
            - CVE
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - ERN
            - ETB
            - EUR
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LYD
            - MAD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRU
            - MUR
            - MVR
            - MWK
            - MXN
            - MXV
            - MYR
            - MZN
            - NAD
            - NGN
            - NIO
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLE
            - SOS
            - SRD
            - SSP
            - STN
            - SVC
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - USD
            - USN
            - UYI
            - UYU
            - UYW
            - UZS
            - VED
            - VES
            - VND
            - VUV
            - WST
            - XAF
            - XAG
            - XAU
            - XBA
            - XBB
            - XBC
            - XBD
            - XCD
            - XDR
            - XOF
            - XPD
            - XPF
            - XPT
            - XSU
            - XTS
            - XUA
            - XXX
            - YER
            - ZAR
            - ZMW
            - ZWL
          example: EUR
          type: string
        decimalPlaces:
          description: >-
            Number of decimal places. If omitted, the default for the currency
            applies.
          example: 2
          format: int64
          type: integer
        value:
          description: Monetary value as integer (no decimals)
          example: 1299
          format: int64
          type: integer
      required:
        - value
        - currency
      title: MonetaryValue
      type: object
      description: MonetaryValue
    Money:
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        decimalPlaces:
          type: number
        value:
          type: number
      required:
        - value
        - currency
      type: object
      xml:
        name: Money
      title: Money
      description: Money
    MoveHandoverJobLineItemsActionEnum:
      enum:
        - MOVE_HANDOVER_JOB_LINE_ITEMS
      type: string
      title: MoveHandoverJobLineItemsActionEnum
      description: MoveHandoverJobLineItemsActionEnum
    MoveHandoverJobLineItemsActionParameter:
      additionalProperties: false
      description: >-
        Action to move line items of a handover job from line items array to
        another (expected, missing, handover)
      properties:
        items:
          items:
            $ref: '#/components/schemas/MoveHandoverJobLineItemsInfo'
          maxItems: 50
          minItems: 1
          type: array
        name:
          $ref: '#/components/schemas/MoveHandoverJobLineItemsActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - items
      title: MoveHandoverJobLineItemsActionParameter
    MoveHandoverJobLineItemsArrayTypeEnum:
      enum:
        - EXPECTED
        - HANDOVER
        - MISSING
      type: string
      title: MoveHandoverJobLineItemsArrayTypeEnum
      description: MoveHandoverJobLineItemsArrayTypeEnum
    MoveHandoverJobLineItemsInfo:
      additionalProperties: false
      description: >-
        Information about the line items that should be moved from one array to
        another
      properties:
        from:
          $ref: '#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum'
        lineItemId:
          description: >-
            References the id of the line item of a handover job. Can be the id
            of a expectedHandoverJobLineItem, handoverLineItem or
            missingHandoverJobLineItem
          type: string
        targetQuantity:
          description: The quantity of the line item that should be moved.
          example: 21
          minimum: 1
          type: integer
        to:
          $ref: '#/components/schemas/MoveHandoverJobLineItemsArrayTypeEnum'
      required:
        - lineItemId
        - from
        - to
        - targetQuantity
      title: MoveHandoverJobLineItemsInfo
    MoveStockToLocationOptions:
      properties:
        deleteFromStockIfZero:
          type: boolean
      title: MoveStockToLocationOptions
      type: object
      description: MoveStockToLocationOptions
    MultiOrderPickingConfiguration:
      additionalProperties: false
      properties:
        maxAmountOfPickJobsForMultiOrderPick:
          description: >-
            The maximum amount of pick jobs that can be combined in a multi
            order pick. Must be a value between 1 and 100.
          maximum: 100
          minimum: 1
          type: integer
      required:
        - maxAmountOfPickJobsForMultiOrderPick
      type: object
      title: MultiOrderPickingConfiguration
      description: MultiOrderPickingConfiguration
    NamedFile:
      additionalProperties: false
      properties:
        content:
          description: File content base64 encoded
          example: >-
            JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==
          type: string
        name:
          description: File name with extension
          example: example.pdf
          type: string
      required:
        - name
        - content
      type: object
      xml:
        name: NamedFile
      title: NamedFile
      description: NamedFile
    NeedsPacking:
      properties:
        needsPacking:
          type: boolean
      required:
        - needsPacking
      type: object
      title: NeedsPacking
      description: NeedsPacking
    NodeType:
      enum:
        - SUPPLIER
        - MANAGED_FACILITY
        - CUSTOMER
      type: string
      title: NodeType
      description: NodeType
    NonDeliveryDays:
      properties:
        nonDeliveryDay:
          description: The non-delivery day in YYYY-MM-DD format
          example: 2020-02-03T00:00:00.000Z
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
        nonDeliveryType:
          default: SINGLE
          description: Type of non-delivery day
          enum:
            - SINGLE
            - RECURRING
          example: SINGLE
          type: string
      required:
        - nonDeliveryDay
      title: NonDeliveryDays
      type: object
      description: NonDeliveryDays
    NonDeliveryDaysPerCountryAndProvince:
      properties:
        country:
          description: The country code
          example: US
          type: string
        nonDeliveryDays:
          description: Non-delivery days for this country
          items:
            $ref: '#/components/schemas/NonDeliveryDays'
          maxItems: 500
          type: array
        nonDeliveryDaysPerProvince:
          description: Non-delivery days per province within this country
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerProvince'
          maxItems: 500
          type: array
        recurringNonDeliveryWeekdays:
          description: Recurring non-delivery weekdays for this country
          items:
            enum:
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
              - SUNDAY
            type: string
          maxItems: 7
          type: array
      required:
        - country
        - nonDeliveryDays
        - recurringNonDeliveryWeekdays
        - nonDeliveryDaysPerProvince
      title: NonDeliveryDaysPerCountryAndProvince
      type: object
      description: NonDeliveryDaysPerCountryAndProvince
    NonDeliveryDaysPerProvince:
      properties:
        nonDeliveryDays:
          description: Non-delivery days for this province
          items:
            $ref: '#/components/schemas/NonDeliveryDays'
          maxItems: 500
          type: array
        province:
          description: The province identifier
          type: string
        recurringNonDeliveryWeekdays:
          description: Recurring non-delivery weekdays for this province
          items:
            enum:
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
              - SUNDAY
            type: string
          maxItems: 7
          type: array
      required:
        - province
        - nonDeliveryDays
        - recurringNonDeliveryWeekdays
      title: NonDeliveryDaysPerProvince
      type: object
      description: NonDeliveryDaysPerProvince
    NonDeliveryType:
      enum:
        - SINGLE
        - RECURRING
      type: string
      title: NonDeliveryType
      description: NonDeliveryType
    Notification:
      properties:
        category:
          description: The category of the notification.
          enum:
            - ORDER
            - FACILITY
            - MISC
          type: string
        created:
          description: Timestamp when the notification was created.
          format: date-time
          type: string
        event:
          description: The event name that triggered the notification.
          type: string
        id:
          description: Identifier of the notification.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Last modification timestamp of the notification.
          format: date-time
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/NotificationPayload'
          description: The payload of the notification.
        priority:
          allOf:
            - $ref: '#/components/schemas/NotificationPriority'
          description: The priority of the notification
        status:
          description: The status of the notification
          enum:
            - OPEN
            - FINISHED
          type: string
        type:
          description: The type of the notification channel.
          enum:
            - EMAIL
            - CLIENT
          type: string
        version:
          description: Current version of the notification.
          example: 1
          type: number
      required:
        - created
        - id
        - lastModified
        - version
        - category
        - status
        - priority
        - event
        - payload
        - type
      title: Notification
      type: object
      description: Notification
    NotificationAction:
      properties:
        name:
          description: Which action to perform
          enum:
            - ACK_NOTIFICATION
          type: string
        version:
          description: The current version of the notification that should be modified
          example: 1
          type: number
      required:
        - version
        - name
      title: NotificationAction
      type: object
      description: NotificationAction
    NotificationApiNotificationStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - FINISHED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - FINISHED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - FINISHED
          type: string
      title: NotificationApiNotificationStatusEnumFilter
      type: object
      description: NotificationApiNotificationStatusEnumFilter
    NotificationCategoryEnumFilter:
      properties:
        eq:
          description: Search by category
          enum:
            - ORDER
            - FACILITY
            - MISC
          type: string
        in:
          description: Search by category
          items:
            enum:
              - ORDER
              - FACILITY
              - MISC
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by category
          enum:
            - ORDER
            - FACILITY
            - MISC
          type: string
      title: NotificationCategoryEnumFilter
      type: object
      description: NotificationCategoryEnumFilter
    NotificationCenterConfig:
      properties:
        channels:
          items:
            oneOf:
              - $ref: '#/components/schemas/EmailNotificationChannel'
              - $ref: '#/components/schemas/ClientNotificationChannel'
          maxItems: 100
          type: array
        created:
          format: date-time
          type: string
        lastModified:
          format: date-time
          type: string
        version:
          type: number
      required:
        - version
        - created
        - lastModified
        - channels
      title: NotificationCenterConfig
      type: object
      description: NotificationCenterConfig
    NotificationCenterConfigForCreation:
      properties:
        channels:
          items:
            oneOf:
              - $ref: '#/components/schemas/EmailNotificationChannelForCreation'
              - $ref: '#/components/schemas/ClientNotificationChannelForCreation'
          maxItems: 100
          type: array
      required:
        - channels
      title: NotificationCenterConfigForCreation
      type: object
      description: NotificationCenterConfigForCreation
    NotificationCenterConfigForUpdate:
      properties:
        channels:
          items:
            oneOf:
              - $ref: '#/components/schemas/EmailNotificationChannelForCreation'
              - $ref: '#/components/schemas/ClientNotificationChannelForCreation'
          maxItems: 100
          type: array
        version:
          type: number
      required:
        - channels
        - version
      title: NotificationCenterConfigForUpdate
      type: object
      description: NotificationCenterConfigForUpdate
    NotificationPaginatedResult:
      properties:
        notifications:
          items:
            $ref: '#/components/schemas/Notification'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - notifications
      title: NotificationPaginatedResult
      type: object
      description: NotificationPaginatedResult
    NotificationPayload:
      properties:
        titleLocalized:
          additionalProperties:
            type: string
          description: >-
            The localized title of the notification (only for client
            notifications).
          type: object
        subjectLocalized:
          additionalProperties:
            type: string
          description: >-
            The localized subject of the notification (only for email
            notifications).
          type: object
        messageLocalized:
          additionalProperties:
            type: string
          description: The localized message of the notification.
          type: object
        entityLinks:
          description: Array of entity links related to this notification
          items:
            $ref: '#/components/schemas/EntityLink'
          type: array
        message:
          description: The message of the notification.
          type: string
        subject:
          description: The subject of the notification (only for email notifications).
          type: string
        title:
          description: The title of the notification (only for client notifications).
          type: string
      required:
        - messageLocalized
        - entityLinks
      title: NotificationPayload
      type: object
      description: NotificationPayload
    NotificationPriority:
      properties:
        label:
          description: Priority label
          enum:
            - LOW
            - MEDIUM
            - HIGH
          type: string
        sequence:
          description: Priority sequence number
          type: number
      required:
        - sequence
        - label
      title: NotificationPriority
      type: object
      description: NotificationPriority
    NotificationPriorityFilter:
      properties:
        label:
          allOf:
            - $ref: '#/components/schemas/NotificationPriorityPriorityLabelEnumFilter'
          description: Search by label
        sequence:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by sequence
      title: NotificationPriorityFilter
      type: object
      description: NotificationPriorityFilter
    NotificationPriorityPriorityLabelEnumFilter:
      properties:
        eq:
          description: Search by label
          enum:
            - LOW
            - MEDIUM
            - HIGH
          type: string
        in:
          description: Search by label
          items:
            enum:
              - LOW
              - MEDIUM
              - HIGH
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by label
          enum:
            - LOW
            - MEDIUM
            - HIGH
          type: string
      title: NotificationPriorityPriorityLabelEnumFilter
      type: object
      description: NotificationPriorityPriorityLabelEnumFilter
    NotificationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/NotificationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/NotificationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: NotificationSearchPayload
      type: object
      description: NotificationSearchPayload
    NotificationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/NotificationSearchQuery'
          maxItems: 500
          type: array
        category:
          allOf:
            - $ref: '#/components/schemas/NotificationCategoryEnumFilter'
          description: Search by category
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/NotificationSearchQuery'
          maxItems: 500
          type: array
        priority:
          allOf:
            - $ref: '#/components/schemas/NotificationPriorityFilter'
          description: Nested search by priority
        status:
          allOf:
            - $ref: '#/components/schemas/NotificationApiNotificationStatusEnumFilter'
          description: Search by status
      title: NotificationSearchQuery
      type: object
      description: NotificationSearchQuery
    NotificationSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        status:
          enum:
            - ASC
            - DESC
          type: string
      title: NotificationSort
      type: object
      description: NotificationSort
    NumberEqFilter:
      properties:
        eq:
          type: number
        gt:
          type: number
        gte:
          type: number
        lt:
          type: number
        lte:
          type: number
        notEq:
          type: number
      title: NumberEqFilter
      type: object
      description: NumberEqFilter
    NumberFilter:
      properties:
        eq:
          type: number
        gt:
          type: number
        gte:
          type: number
        in:
          items:
            type: number
          maxItems: 25
          type: array
        lt:
          type: number
        lte:
          type: number
        notEq:
          type: number
        notIn:
          items:
            type: number
          maxItems: 25
          type: array
      title: NumberFilter
      type: object
      description: NumberFilter
    OfferedDocument:
      properties:
        documentCategory:
          $ref: '#/components/schemas/DocumentCategory'
      required:
        - documentCategory
      type: object
      title: OfferedDocument
      description: OfferedDocument
    OfferedDocumentPerTag:
      properties:
        matchingValues:
          items:
            minItems: 1
            type: string
          maxItems: 500
          type: array
        offeredDocuments:
          items:
            $ref: '#/components/schemas/OfferedDocument'
          maxItems: 500
          type: array
        tagRef:
          type: string
      required:
        - offeredDocuments
        - matchingValues
        - tagRef
      type: object
      title: OfferedDocumentPerTag
      description: OfferedDocumentPerTag
    OfferedScanningRuleByTag:
      additionalProperties: false
      properties:
        matchingValues:
          items:
            type: string
          minItems: 1
          type: array
        scanningType:
          $ref: '#/components/schemas/PickingScanningConfigurationEnum'
        tagRef:
          minLength: 1
          type: string
      required:
        - tagRef
        - matchingValues
        - scanningType
      type: object
      title: OfferedScanningRuleByTag
      description: OfferedScanningRuleByTag
    OfferedStickersByTag:
      additionalProperties: false
      properties:
        matchingValues:
          items:
            type: string
          maxItems: 500
          minItems: 1
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 500
          minItems: 1
          type: array
        tagRef:
          type: string
      required:
        - tagRef
        - matchingValues
        - stickers
      type: object
      title: OfferedStickersByTag
      description: OfferedStickersByTag
    OidcProviderCustomParameter:
      properties:
        key:
          type: string
        value:
          type: string
      required:
        - key
        - value
      title: OidcProviderCustomParameter
      type: object
      description: OidcProviderCustomParameter
    OidcProviderForCreation:
      properties:
        assignedGroups:
          description: The assigned groups of the OIDC provider
          items:
            $ref: '#/components/schemas/AssignedGroup'
          type: array
        clientId:
          description: The client id of the OIDC provider
          type: string
        clientSecret:
          description: The client secret of the OIDC provider
          type: string
        customParameters:
          description: The custom parameters of the OIDC provider
          items:
            $ref: '#/components/schemas/OidcProviderCustomParameter'
          type: array
        issuer:
          description: The issuer of the OIDC provider
          type: string
        name:
          description: The name of the OIDC provider
          type: string
        roleManagementMode:
          description: >-
            Determines whether role assignments of this OIDC provider are
            managed by the IDP (IDP_MANAGED, default) or locally in
            fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always
            stays IDP-managed.
          enum:
            - IDP_MANAGED
            - IDP_IDENTITY_ONLY
          type: string
        status:
          description: The status of the OIDC provider
          enum:
            - ACTIVE
            - INACTIVE
          type: string
      required:
        - name
        - status
        - issuer
        - clientId
        - customParameters
        - assignedGroups
        - clientSecret
      title: OidcProviderForCreation
      type: object
      description: OidcProviderForCreation
    OidcProviderForPatch:
      properties:
        assignedGroups:
          description: The assigned groups of the OIDC provider
          items:
            $ref: '#/components/schemas/AssignedGroup'
          type: array
        clientId:
          description: The client id of the OIDC provider
          type: string
        clientSecret:
          description: The client secret of the OIDC provider
          type: string
        customParameters:
          description: The custom parameters of the OIDC provider
          items:
            $ref: '#/components/schemas/OidcProviderCustomParameter'
          type: array
        issuer:
          description: The issuer of the OIDC provider
          type: string
        name:
          description: The name of the OIDC provider
          type: string
        roleManagementMode:
          description: >-
            Determines whether role assignments of this OIDC provider are
            managed by the IDP (IDP_MANAGED, default) or locally in
            fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always
            stays IDP-managed.
          enum:
            - IDP_MANAGED
            - IDP_IDENTITY_ONLY
          type: string
        status:
          description: The status of the OIDC provider
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          description: The version of the OIDC provider
          example: 1
          type: number
      required:
        - version
      title: OidcProviderForPatch
      type: object
      description: OidcProviderForPatch
    OidcProviderForUpdate:
      properties:
        assignedGroups:
          description: The assigned groups of the OIDC provider
          items:
            $ref: '#/components/schemas/AssignedGroup'
          type: array
        clientId:
          description: The client id of the OIDC provider
          type: string
        clientSecret:
          description: The client secret of the OIDC provider
          type: string
        customParameters:
          description: The custom parameters of the OIDC provider
          items:
            $ref: '#/components/schemas/OidcProviderCustomParameter'
          type: array
        issuer:
          description: The issuer of the OIDC provider
          type: string
        name:
          description: The name of the OIDC provider
          type: string
        roleManagementMode:
          description: >-
            Determines whether role assignments of this OIDC provider are
            managed by the IDP (IDP_MANAGED, default) or locally in
            fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always
            stays IDP-managed.
          enum:
            - IDP_MANAGED
            - IDP_IDENTITY_ONLY
          type: string
        status:
          description: The status of the OIDC provider
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          description: The version of the OIDC provider
          example: 1
          type: number
      required:
        - name
        - status
        - issuer
        - clientId
        - customParameters
        - assignedGroups
        - clientSecret
        - version
      title: OidcProviderForUpdate
      type: object
      description: OidcProviderForUpdate
    OidcProviders:
      properties:
        providers:
          description: The list of OIDC providers
          items:
            $ref: '#/components/schemas/StrippedOidcProvider'
          type: array
        total:
          description: The total number of OIDC providers
          type: number
      required:
        - total
        - providers
      title: OidcProviders
      type: object
      description: OidcProviders
    OpenItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - OpenItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: OpenItemReturnActionParameter
      type: object
      description: OpenItemReturnActionParameter
    OperationalRestowingConfigurations:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        restowingProcessConfiguration:
          $ref: '#/components/schemas/RestowingProcessConfiguration'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      title: OperationalRestowingConfigurations
      description: OperationalRestowingConfigurations
    OperativeContainerType:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        allowedOperativeTypes:
          items:
            enum:
              - PICKING
              - PACKING_SOURCE
              - PACKING_TARGET
              - HANDOVER
              - SERVICE
            type: string
          minItems: 1
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the operativeContainerType. These
            attributes cannot be used within fulfillment processes.
          type: object
        description:
          type: string
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        iconUrl:
          type: string
        id:
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        name:
          deprecated: true
          description: 'Deprecated: use nameLocalized instead'
          type: string
        priority:
          description: >-
            This value gives the priority of the respective
            operativeContainerType. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10.
          example: 100
          format: int32
          maximum: 10000
          minimum: 1
          type: integer
        scannableIdentifiers:
          items:
            $ref: '#/components/schemas/ScannableIdentifier'
          maxItems: 1
          type: array
        status:
          enum:
            - INACTIVE
            - ACTIVE
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        weightLimitInG:
          description: Maximal weight in gramm(gr) the container can be loaded with.
          example: 2500
          minimum: 1
          type: number
      required:
        - version
        - id
        - nameLocalized
        - allowedOperativeTypes
      title: OperativeContainerType
      type: object
      description: OperativeContainerType
    OperativeContainerTypeForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        allowedOperativeTypes:
          items:
            enum:
              - PICKING
              - PACKING_SOURCE
              - PACKING_TARGET
              - HANDOVER
              - SERVICE
            type: string
          maxItems: 10
          minItems: 1
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the operativeContainerType. These
            attributes cannot be used within fulfillment processes.
          type: object
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        icon:
          $ref: '#/components/schemas/NamedFile'
        iconUrl:
          type: string
        priority:
          description: >-
            This value gives the priority of the respective
            operativeContainerType. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10.
          example: 100
          format: int32
          maximum: 10000
          minimum: 1
          type: integer
        scannableIdentifiers:
          items:
            $ref: '#/components/schemas/ScannableIdentifier'
          maxItems: 1
          type: array
        status:
          enum:
            - INACTIVE
            - ACTIVE
          type: string
        weightLimitInG:
          description: Maximal weight in gramm(gr) the container can be loaded with.
          example: 2500
          minimum: 1
          type: number
      required:
        - nameLocalized
        - allowedOperativeTypes
      title: OperativeContainerTypeForCreation
      type: object
      description: OperativeContainerTypeForCreation
    OperativeContainerTypeForUpdate:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        allowedOperativeTypes:
          items:
            enum:
              - PICKING
              - PACKING_SOURCE
              - PACKING_TARGET
              - HANDOVER
              - SERVICE
            type: string
          maxItems: 10
          minItems: 1
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the operativeContainerTypes. These
            attributes cannot be used within fulfillment processes.
          type: object
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        iconUrl:
          type: string
        priority:
          description: >-
            This value gives the priority of the respective
            operativeContainerType. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10.
          example: 100
          format: int32
          maximum: 10000
          minimum: 1
          type: integer
        scannableIdentifiers:
          items:
            $ref: '#/components/schemas/ScannableIdentifier'
          maxItems: 1
          type: array
        status:
          enum:
            - INACTIVE
            - ACTIVE
          type: string
        version:
          example: 1
          minimum: 1
          type: integer
        weightLimitInG:
          description: Maximal weight in gramm(gr) the container can be loaded with.
          example: 2500
          minimum: 1
          type: number
      required:
        - version
      title: OperativeContainerTypeForUpdate
      type: object
      description: OperativeContainerTypeForUpdate
    OperativeContainerTypesResponse:
      properties:
        operativeContainerTypes:
          items:
            $ref: '#/components/schemas/OperativeContainerType'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      title: OperativeContainerTypesResponse
      type: object
      description: OperativeContainerTypesResponse
    OperativeEntity:
      properties:
        entityChildren:
          description: Tree structure of entities belonging to this entity
          items:
            $ref: '#/components/schemas/OperativeEntity'
            minLength: 0
          type: array
        entityRef:
          description: Reference to the full entity
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        entityType:
          description: Type of the entity
          enum:
            - PICK_JOB
            - PACK_JOB
            - SHIPMENT
            - SHIPPING_INFORMATION
            - HANDOVER_JOB
            - PARCEL
            - PARCEL_INFORMATION
            - SERVICE_JOB
            - RESTOW_ITEM
            - ITEM_RETURN_JOB
            - LINKED_SERVICE_JOBS
            - PACKING_TARGET_CONTAINER
            - LOAD_UNIT
            - SERVICE_CONTAINER
            - HANDOVER_CONTAINER
          type: string
      required:
        - entityRef
        - entityType
      title: OperativeEntity
      type: object
      description: OperativeEntity
    OperativeEntityPayloadBase:
      properties:
        facility:
          $ref: '#/components/schemas/ProcessHistoryLogFacility'
        shortId:
          type: string
      required:
        - facility
      type: object
      title: OperativeEntityPayloadBase
      description: OperativeEntityPayloadBase
    OperativeEntityPickingDoneIncompletePayload:
      allOf:
        - $ref: '#/components/schemas/OperativeEntityPayloadBase'
      properties:
        shortPickedItems:
          items:
            $ref: '#/components/schemas/OperativeEntityShortPickedItem'
          type: array
      title: OperativeEntityPickingDoneIncompletePayload
      description: OperativeEntityPickingDoneIncompletePayload
    OperativeEntityShortPickedItem:
      properties:
        article:
          $ref: '#/components/schemas/ArticleHistoryLog'
        picked:
          type: number
        quantity:
          type: number
        shortPickReason:
          $ref: '#/components/schemas/PickLineShortPickReason'
      required:
        - article
        - picked
        - quantity
      type: object
      title: OperativeEntityShortPickedItem
      description: OperativeEntityShortPickedItem
    OperativeProcess:
      properties:
        created:
          description: The timestamp when the operative process was created.
          format: date-time
          type: string
        entityChildren:
          description: >-
            Entities involved in this operative process represented as a
            hierarchical tree structure.
          items:
            $ref: '#/components/schemas/OperativeEntity'
            minLength: 0
          type: array
        facilityRef:
          description: Reference to the facility this operative process is associated with.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        flatEntityRefs:
          description: >-
            Entities involved in this operative process represented as a flat
            list of entity references.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            minLength: 0
            type: string
          type: array
        id:
          description: auto generated unique identifier
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        isEditable:
          description: >-
            This field indicates if the operative process is editable based on
            if any of the related pick jobs, service jobs, pack jobs or handover
            jobs are in progress or have been finished successfully. This field
            is calculated dynamically on each request.
          type: boolean
        lastModified:
          description: The timestamp when the operative process was last modified.
          format: date-time
          type: string
        processRef:
          description: Reference to the process this operative process is associated with.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        routingPlanRef:
          description: >-
            Reference to the routing plan this operative process is associated
            with.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        version:
          description: >-
            The version number of the operative process. This number is
            incremented each time the operative process is modified.
          example: 1
          type: number
      required:
        - id
        - version
        - processRef
        - facilityRef
        - flatEntityRefs
        - entityChildren
      title: OperativeProcess
      type: object
      description: OperativeProcess
    OperativeProcessPaginatedResult:
      properties:
        operativeProcesses:
          items:
            $ref: '#/components/schemas/OperativeProcess'
          type: array
        pageInfo:
          $ref: '#/components/schemas/PageInfo'
        total:
          minimum: 0
          type: number
      required:
        - total
        - pageInfo
        - operativeProcesses
      title: OperativeProcessPaginatedResult
      type: object
      description: OperativeProcessPaginatedResult
    OperativeServiceConfiguration:
      properties:
        cancelReasons:
          description: >-
            Predefined reasons that can be selected when cancelling a service
            job
          items:
            $ref: '#/components/schemas/ServiceJobCancelReason'
          maxItems: 50
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          description: ID of the Operative Service Configuration is always operativeservice
          example: operativeservice
          minLength: 1
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - created
        - lastModified
        - version
        - id
      title: OperativeServiceConfiguration
      type: object
      description: OperativeServiceConfiguration
    OperativeServiceConfigurationForUpsert:
      properties:
        cancelReasons:
          description: >-
            Predefined reasons that can be selected when cancelling a service
            job
          items:
            $ref: '#/components/schemas/ServiceJobCancelReason'
          maxItems: 50
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms
          example: 42
          minimum: 1
          type: integer
      required:
        - version
      title: OperativeServiceConfigurationForUpsert
      type: object
      description: OperativeServiceConfigurationForUpsert
    OperativeTransfer:
      additionalProperties: false
      properties:
        id:
          description: The ID of the transfer
          example: 018fe899-80ec-70f8-9bda-f7cc904bc0bf
          type: string
        type:
          description: The type of the transfer
          enum:
            - SUPPLIER
            - RECEIVER
          example: RECEIVER
          type: string
      required:
        - id
        - type
      title: OperativeTransfer
      type: object
      description: OperativeTransfer
    OptimizationHints:
      properties:
        includeCalculationHints:
          default: false
          description: >-
            Should only be used for debugging. Includes more information on how
            we calculated the response.
          type: boolean
        requestedResultCount:
          default: 1
          description: Number of different results we calculated
          example: 3
          maximum: 20
          type: integer
      type: object
      title: OptimizationHints
      description: OptimizationHints
    Order:
      allOf:
        - $ref: '#/components/schemas/OrderForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            cancelationReason:
              $ref: '#/components/schemas/CancelationReason'
            customServices:
              items:
                $ref: '#/components/schemas/CustomServiceReference'
              minItems: 1
              type: array
            id:
              description: >-
                The id of this order. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: LGMl2DuvPnfPoSHhYFOm
              type: string
            orderLineItems:
              items:
                $ref: '#/components/schemas/OrderLineItem'
              type: array
            paymentInfo:
              $ref: '#/components/schemas/OrderPaymentInfo'
            pricing:
              allOf:
                - $ref: '#/components/schemas/OrderPricing'
              description: >-
                This part of the API is in Alpha status. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />
              x-badges:
                - color: red
                  label: ALPHA
            processId:
              description: >-
                Id of the global process related to this entity. For example
                used for starting the GDPR process and others.
              type: string
            schemaVersion:
              type: number
            status:
              $ref: '#/components/schemas/OrderStatus'
            updateDetails:
              items:
                $ref: '#/components/schemas/OrderUpdateDetail'
              minItems: 1
              type: array
            workflowInformation:
              oneOf:
                - $ref: '#/components/schemas/WorkflowInformation'
                - $ref: '#/components/schemas/WorkflowUnavailable'
          required:
            - id
            - status
            - orderLineItems
            - processId
            - workflowInformation
          type: object
      xml:
        name: Order
      title: Order
      description: Order
    OrderActionsParameter:
      oneOf:
        - $ref: '#/components/schemas/OrderUnlockActionParameter'
        - $ref: '#/components/schemas/OrderCancelActionParameter'
        - $ref: '#/components/schemas/OrderForceCancelActionParameter'
        - $ref: '#/components/schemas/PromiseConfirmActionParameter'
        - $ref: '#/components/schemas/PromiseExtendActionParameter'
        - $ref: '#/components/schemas/OrderConsumerAddressChangeActionParameter'
        - $ref: '#/components/schemas/OrderConsumerAddressesReplaceActionParameter'
      title: OrderActionsParameter
      description: OrderActionsParameter
    OrderArticleAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      title: OrderArticleAttributeItem
      description: OrderArticleAttributeItem
    OrderCancelActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      description: Action to cancel an order.
      properties:
        cancelationReasonId:
          description: ID of the cancelation reason
          type: string
        name:
          enum:
            - CANCEL
          type: string
      required:
        - name
        - version
      title: OrderCancelActionParameter
    OrderCancelationConfiguration:
      additionalProperties: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        configuration is to define specific rules for canceling orders such as
        the forced cancelation.
      properties:
        allowForceCancelOrder:
          type: boolean
        created:
          description: >-
            The date this configuration was created at the platform. This value
            is generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          type: string
        version:
          description: >-
            The version of the configuration to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - allowForceCancelOrder
      type: object
      title: OrderCancelationConfiguration
      x-badges:
        - color: orange
          label: BETA
    OrderCancellationPayload:
      properties:
        cancelationReason:
          $ref: '#/components/schemas/CancelationReasonHistoryLog'
      type: object
      title: OrderCancellationPayload
      description: OrderCancellationPayload
    OrderCancelledByExpiryEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Order'
      required:
        - payload
      type: object
      title: OrderCancelledByExpiryEvent
      description: OrderCancelledByExpiryEvent
    OrderCancelledWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Order'
      required:
        - payload
      type: object
      title: OrderCancelledWebHookEvent
      description: OrderCancelledWebHookEvent
    OrderConsumerAddressChangeActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      deprecated: true
      description: >-
        @deprecated use PATCH /api/orders/:id instead 'Action to change a
        consumer address of an order, e.g. the postal address.'
      properties:
        addressType:
          $ref: '#/components/schemas/AddressType'
        consumerAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        name:
          enum:
            - CHANGE_CONSUMER_ADDRESS
          type: string
      required:
        - name
        - version
        - consumerAddress
        - addressType
      title: OrderConsumerAddressChangeActionParameter
    OrderConsumerAddressesAddressTypeEnumFilter:
      properties:
        eq:
          description: Search by addressType
          enum:
            - POSTAL_ADDRESS
            - PARCEL_LOCKER
            - INVOICE_ADDRESS
          type: string
        in:
          description: Search by addressType
          items:
            enum:
              - POSTAL_ADDRESS
              - PARCEL_LOCKER
              - INVOICE_ADDRESS
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by addressType
          enum:
            - POSTAL_ADDRESS
            - PARCEL_LOCKER
            - INVOICE_ADDRESS
          type: string
      title: OrderConsumerAddressesAddressTypeEnumFilter
      type: object
      description: OrderConsumerAddressesAddressTypeEnumFilter
    OrderConsumerAddressesFilter:
      properties:
        addressType:
          allOf:
            - $ref: '#/components/schemas/OrderConsumerAddressesAddressTypeEnumFilter'
          description: Search by addressType
        city:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by city
          example: Yellowstone
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by companyName
        country:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by country
          example: US
        email:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by firstName
        houseNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by houseNumber
          example: 42
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by lastName
        postalCode:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by postalCode
          example: '42420'
        province:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by province
        street:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by street
      title: OrderConsumerAddressesFilter
      type: object
      description: OrderConsumerAddressesFilter
    OrderConsumerAddressesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderConsumerAddressesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderConsumerAddressesListFilter
      type: object
      description: OrderConsumerAddressesListFilter
    OrderConsumerAddressesReplaceActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      deprecated: true
      description: >-
        @deprecated use PATCH /api/orders/:id instead 'Action to replace all
        consumer addresses of an order.'
      properties:
        consumerAddresses:
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 500
          type: array
        name:
          enum:
            - REPLACE_CONSUMER_ADDRESSES
          type: string
      required:
        - name
        - version
        - consumerAddresses
      title: OrderConsumerAddressesReplaceActionParameter
    OrderConsumerFilter:
      properties:
        addresses:
          allOf:
            - $ref: '#/components/schemas/OrderConsumerAddressesListFilter'
          description: Nested list search by addresses
        consumerId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by consumerId
      title: OrderConsumerFilter
      type: object
      description: OrderConsumerFilter
    OrderCreatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Order'
      required:
        - payload
      type: object
      title: OrderCreatedWebHookEvent
      description: OrderCreatedWebHookEvent
    OrderDeliveryPreferencesCollectFilter:
      properties:
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        paid:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by paid
      title: OrderDeliveryPreferencesCollectFilter
      type: object
      description: OrderDeliveryPreferencesCollectFilter
    OrderDeliveryPreferencesCollectListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderDeliveryPreferencesCollectFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderDeliveryPreferencesCollectListFilter
      type: object
      description: OrderDeliveryPreferencesCollectListFilter
    OrderDeliveryPreferencesFilter:
      properties:
        collect:
          allOf:
            - $ref: '#/components/schemas/OrderDeliveryPreferencesCollectListFilter'
          description: Nested list search by collect
        shipping:
          allOf:
            - $ref: '#/components/schemas/OrderDeliveryPreferencesShippingFilter'
          description: Nested search by shipping
      title: OrderDeliveryPreferencesFilter
      type: object
      description: OrderDeliveryPreferencesFilter
    OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter:
      properties:
        eq:
          description: Search by serviceLevel
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
        in:
          description: Search by serviceLevel
          items:
            enum:
              - DELIVERY
              - SAMEDAY
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by serviceLevel
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
      title: OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter
      type: object
      description: OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter
    OrderDeliveryPreferencesShippingFilter:
      properties:
        desiredDeliveryTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by desiredDeliveryTime
          example: 2026-06-17T12:00:00.000Z
        serviceLevel:
          allOf:
            - $ref: >-
                #/components/schemas/OrderDeliveryPreferencesShippingDeliveryServiceLevelEnumFilter
          description: Search by serviceLevel
      title: OrderDeliveryPreferencesShippingFilter
      type: object
      description: OrderDeliveryPreferencesShippingFilter
    OrderFenceDecision:
      properties:
        decision:
          $ref: '#/components/schemas/FenceResultStatus'
        details:
          items:
            anyOf:
              - $ref: '#/components/schemas/OrderFenceDecisionDetail'
              - $ref: '#/components/schemas/ToolkitDecisionDetail'
              - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail'
          type: array
        name:
          type: string
      required:
        - name
        - decision
        - details
      type: object
      title: OrderFenceDecision
      description: OrderFenceDecision
    OrderFenceDecisionDetail:
      allOf:
        - $ref: '#/components/schemas/BaseDecisionDetail'
      description: Order Fence Decision Detail.
      properties:
        actualValue:
          type: string
        contextReference:
          $ref: '#/components/schemas/ContextReference'
        expectedValue:
          type: string
        reactiveErrorReason:
          $ref: '#/components/schemas/ReactiveErrorReason'
      required:
        - expectedValue
        - decisionType
      title: OrderFenceDecisionDetail
    OrderForceCancelActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      description: Action to force cancel an order.
      properties:
        name:
          enum:
            - FORCE_CANCEL
          type: string
      required:
        - name
        - version
      title: OrderForceCancelActionParameter
    OrderForceCancelledWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Order'
      required:
        - payload
      type: object
      title: OrderForceCancelledWebHookEvent
      description: OrderForceCancelledWebHookEvent
    OrderForCreation:
      additionalProperties: false
      properties:
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
        customAttributes:
          description: >-
            Attributes that can be added to the order. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        customServices:
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          maxItems: 500
          minItems: 1
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
        orderDate:
          description: The date this order was created at the supplying system.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          maxItems: 500
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
        pricing:
          allOf:
            - $ref: '#/components/schemas/OrderPricingForCreation'
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          x-badges:
            - color: red
              label: ALPHA
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
        source:
          description: >-
            Defines the source of this order. This field is not required, if the
            order is created based on an external system.
          oneOf:
            - $ref: '#/components/schemas/SourceRef'
            - $ref: '#/components/schemas/TenantSourceId'
          type: object
        status:
          $ref: '#/components/schemas/OrderStatus'
        statusReasons:
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          maxItems: 500
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          minItems: 1
          type: array
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 500
          minItems: 1
          type: array
      required:
        - orderDate
        - orderLineItems
        - consumer
      type: object
      xml:
        name: Order
      title: OrderForCreation
      description: OrderForCreation
    OrderForCreationConsumer:
      properties:
        addresses:
          items:
            $ref: '#/components/schemas/ConsumerAddress'
          maxItems: 500
          type: array
        consumerId:
          description: The id of the consumer.
          example: e4213a07-f563-46a3-b1ba-4dfeb6abe82a
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the consumer. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        email:
          deprecated: true
          description: >
            @deprecated The email address of the consumer. Use email in
            addresses array
          example: max@speedyboxales.com
          format: email
          type: string
        facilityRef:
          description: ID of the facility, if the recipient is a facility.
          example: e4213a07-f563-46a3-b1ba-4dfeb6abe82a
          type: string
        tenantFacilityId:
          description: tenantFacilityId of the facility, if the recipient is a facility
          type: string
      type: object
      title: OrderForCreationConsumer
      description: OrderForCreationConsumer
    OrderForSourcingOptionsRequest:
      additionalProperties: false
      properties:
        consumer:
          $ref: '#/components/schemas/ConsumerAddressesForSourcingOptions'
        customAttributes:
          description: >-
            Attributes that can be added to the order. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        customServices:
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          minItems: 1
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
        orderDate:
          description: The date this order was created at the supplying system.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
        status:
          $ref: '#/components/schemas/OrderStatus'
        statusReasons:
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          minItems: 1
          type: array
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - consumer
      type: object
      xml:
        name: OrderForSourcingOptionsRequest
      title: OrderForSourcingOptionsRequest
      description: OrderForSourcingOptionsRequest
    OrderForUpdate:
      additionalProperties: false
      properties:
        comment:
          description: A comment for updating this order.
          type: string
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
        customAttributes:
          description: >-
            Attributes that can be added to the order. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          nullable: true
          type: object
        orderLineItems:
          description: >-
            Updates the order line items of the order. All order lines must be
            included, only the included lines will remain after the update.
          items:
            $ref: '#/components/schemas/OrderLineItemForUpdate'
          maxItems: 500
          nullable: true
          type: array
        preferredHandlingTime:
          description: >-
            Updates the preferred handling time for ship-from-store orders or
            the provisioning time for click-and-collect orders.
          example: 2025-01-15T00:00:00.000Z
          format: date-time
          type: string
        pricing:
          allOf:
            - $ref: '#/components/schemas/OrderPricingForCreation'
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          x-badges:
            - color: red
              label: ALPHA
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      title: OrderForUpdate
      description: OrderForUpdate
    OrderInformation:
      properties:
        orderDate:
          description: The date the order was created.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        orderNumber:
          description: An identifier for the order.
          example: R456728546
          pattern: ^.+$
          type: string
      type: object
      title: OrderInformation
      description: OrderInformation
    OrderLineItem:
      allOf:
        - $ref: '#/components/schemas/OrderLineItemForCreation'
        - properties:
            id:
              description: >-
                The id of this orderline. It is generated during creation
                automatically by the API and suits as the primary identifier of
                the described line.
              example: LGMl2DuvPnfPoSHhYFOm
              type: string
          required:
            - id
          type: object
      title: OrderLineItem
      description: OrderLineItem
    OrderLineItemActionsParameter:
      oneOf:
        - $ref: '#/components/schemas/OrderLineItemCustomAttributesUpdateParameter'
      type: object
      title: OrderLineItemActionsParameter
      description: OrderLineItemActionsParameter
    OrderLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              description: >-
                Attributes are used in fulfillmenttools to impose a certain
                degree of customization to a process, such as improving the
                appearance in the platform and clients.

                Details about usage can be found in the<a
                href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">article
                attributes article</a>.
              items:
                $ref: '#/components/schemas/OrderArticleAttributeItem'
              maxItems: 500
              type: array
            customAttributes:
              deprecated: true
              description: |
                @deprecated Please use customAttributes in OrderLineItem.
              nullable: true
              type: object
          type: object
      xml:
        name: OrderLineItemArticle
      title: OrderLineItemArticle
      description: OrderLineItemArticle
    OrderLineItemArticleForUpdate:
      allOf:
        - $ref: '#/components/schemas/AbstractArticleForCreation'
        - properties:
            attributes:
              description: >-
                Attributes are used in fulfillmenttools to impose a certain
                degree of customization to a process, such as improving the
                appearance in the platform and clients.

                Details about usage can be found in the <a
                href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">article
                attributes article</a>.
              items:
                $ref: '#/components/schemas/OrderArticleAttributeItem'
              maxItems: 500
              type: array
            customAttributes:
              deprecated: true
              description: |
                @deprecated Please use customAttributes in OrderLineItem.
              nullable: true
              type: object
          type: object
      xml:
        name: OrderLineItemArticleForUpdate
      title: OrderLineItemArticleForUpdate
      description: OrderLineItemArticleForUpdate
    OrderLineItemCustomAttributesUpdateParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderLineItemActionsParameter'
      description: Action to update custom attributes of an order.
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the orderline. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here. If no customAttributes exist
            yet, they will be created for this line item.
          type: object
        name:
          enum:
            - UPDATE_CUSTOM_ATTRIBUTES
          type: string
      required:
        - name
        - version
        - customAttributes
      title: OrderLineItemCustomAttributesUpdateParameter
    OrderLineItemFenceDecision:
      properties:
        articleTitle:
          type: string
        decision:
          $ref: '#/components/schemas/FenceResultStatus'
        details:
          items:
            anyOf:
              - $ref: '#/components/schemas/OrderFenceDecisionDetail'
              - $ref: '#/components/schemas/ToolkitDecisionDetail'
              - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail'
          type: array
        reactiveErrorReason:
          $ref: '#/components/schemas/ReactiveErrorReason'
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - articleTitle
        - decision
        - details
      type: object
      title: OrderLineItemFenceDecision
      description: OrderLineItemFenceDecision
    OrderLineItemFenceDecisions:
      properties:
        name:
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/OrderLineItemFenceDecision'
          type: array
      required:
        - name
        - orderLineItems
      title: OrderLineItemFenceDecisions
      description: OrderLineItemFenceDecisions
    OrderLineItemForCreation:
      additionalProperties: false
      properties:
        allowedSubstitutes:
          description: >-
            Array of allowed substitutes for given orderLineItem. If an empty
            array is provided, no substitute is allowed for this orderLineItem.
            If allowedSubstitutes is not provided, this configured substitutes
            on listing level will be available
          items:
            $ref: '#/components/schemas/Substitute'
          maxItems: 500
          type: array
        article:
          $ref: '#/components/schemas/OrderLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the orderline. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        measurementValidation:
          $ref: '#/components/schemas/MeasurementValidation'
        quantity:
          description: quantity of the specific article that has been ordered
          example: 21
          format: int64
          minimum: 1
          type: integer
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          maxItems: 500
          type: array
        secondaryMeasurementUnitKey:
          description: Secondary identifier for items unit of measurement.
          example: liter
          type: string
        secondaryQuantity:
          description: Secondary quantity of the specific article that has been ordered
          example: 21
          format: int64
          minimum: 0
          type: integer
        shopPrice:
          description: >
            @deprecated price per piece of this line item Use attributes instead
            (see: <a
            href="https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/articles/article-attributes">customization
            by attributes</a>)
          example: 1200
          type: number
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 500
          type: array
      required:
        - article
        - quantity
      type: object
      title: OrderLineItemForCreation
      description: OrderLineItemForCreation
    OrderLineItemForUpdate:
      properties:
        article:
          $ref: '#/components/schemas/OrderLineItemArticleForUpdate'
        id:
          description: >-
            The id of this order line item. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          type: string
        quantity:
          description: The quantity of this order line item.
          example: 2
          type: number
      title: OrderLineItemForUpdate
      description: OrderLineItemForUpdate
    OrderLineItemModifiedLogPayload:
      allOf:
        - $ref: '#/components/schemas/OrderModificationPayloadBase'
      properties:
        articles:
          description: List of modified articles
          items:
            $ref: '#/components/schemas/ArticleHistoryLog'
          type: array
      title: OrderLineItemModifiedLogPayload
      description: OrderLineItemModifiedLogPayload
    OrderModificationConfiguration:
      additionalProperties: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        configuration is to define specific rules for modifying orders after
        order creation.
      properties:
        allowOrderLineItemModification:
          type: boolean
        created:
          description: >-
            The date this configuration was created at the platform. This value
            is generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          type: string
        version:
          description: >-
            The version of the configuration to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - allowOrderLineItemModification
      type: object
      title: OrderModificationConfiguration
      x-badges:
        - color: orange
          label: BETA
    OrderModificationPayloadBase:
      properties:
        reason:
          type: string
      type: object
      title: OrderModificationPayloadBase
      description: OrderModificationPayloadBase
    OrderModificationPreferredHandlingTimePayload:
      allOf:
        - $ref: '#/components/schemas/OrderModificationPayloadBase'
      properties:
        newPreferredHandlingTime:
          description: Updated preferredHandlingTime value
          example: 2025-01-01T08:45:50.525Z
          format: date-time
          nullable: true
          type: string
        previousPreferredHandlingTime:
          description: preferredHandlingTime value before an update
          format: date-time
          nullable: true
          type: string
      required:
        - previousPreferredHandlingTime
        - newPreferredHandlingTime
      title: OrderModificationPreferredHandlingTimePayload
      description: OrderModificationPreferredHandlingTimePayload
    OrderModifiedEventPayload:
      allOf:
        - $ref: '#/components/schemas/Order'
      properties:
        changes:
          $ref: '#/components/schemas/OrderUpdateDetailChanges'
      xml:
        name: OrderModifiedEventPayload
      title: OrderModifiedEventPayload
      description: OrderModifiedEventPayload
    OrderModifiedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/OrderModifiedEventPayload'
      required:
        - payload
      type: object
      title: OrderModifiedWebHookEvent
      description: OrderModifiedWebHookEvent
    OrderOrderLineItemsArticleFilter:
      properties:
        titleLocalized:
          allOf:
            - $ref: >-
                #/components/schemas/OrderOrderLineItemsArticleTitleLocalizedFilter
          description: Nested search by titleLocalized
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by title
      title: OrderOrderLineItemsArticleFilter
      type: object
      description: OrderOrderLineItemsArticleFilter
    OrderOrderLineItemsArticleTitleLocalizedFilter:
      properties:
        de_DE:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by de_DE
        en_US:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by en_US
        ru_RU:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by ru_RU
      title: OrderOrderLineItemsArticleTitleLocalizedFilter
      type: object
      description: OrderOrderLineItemsArticleTitleLocalizedFilter
    OrderOrderLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/OrderOrderLineItemsArticleFilter'
          description: Nested search by article
      title: OrderOrderLineItemsFilter
      type: object
      description: OrderOrderLineItemsFilter
    OrderOrderLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderOrderLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderOrderLineItemsListFilter
      type: object
      description: OrderOrderLineItemsListFilter
    OrderPaginatedResult:
      properties:
        orders:
          items:
            $ref: '#/components/schemas/Order'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - orders
      title: OrderPaginatedResult
      type: object
      description: OrderPaginatedResult
    OrderPaymentInfo:
      additionalProperties: false
      properties:
        methodLocalized:
          $ref: '#/components/schemas/LocaleString'
        currency:
          description: The currency in which the consumer paid with
          example: EUR
          type: string
        method:
          description: Localized value from methodLocalized
          example: Credit Card
          type: string
      type: object
      title: OrderPaymentInfo
      description: OrderPaymentInfo
    OrderPaymentInfoFilter:
      properties:
        methodLocalized:
          allOf:
            - $ref: '#/components/schemas/OrderPaymentInfoMethodLocalizedFilter'
          description: Nested search by methodLocalized
        currency:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by currency
        method:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by method
      title: OrderPaymentInfoFilter
      type: object
      description: OrderPaymentInfoFilter
    OrderPaymentInfoForCreation:
      additionalProperties: false
      properties:
        methodLocalized:
          $ref: '#/components/schemas/LocaleString'
        currency:
          description: The currency in which the consumer paid with
          example: EUR
          type: string
      type: object
      title: OrderPaymentInfoForCreation
      description: OrderPaymentInfoForCreation
    OrderPaymentInfoMethodLocalizedFilter:
      properties:
        de_DE:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by de_DE
        en_US:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by en_US
        ru_RU:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by ru_RU
      title: OrderPaymentInfoMethodLocalizedFilter
      type: object
      description: OrderPaymentInfoMethodLocalizedFilter
    OrderPricing:
      allOf:
        - $ref: '#/components/schemas/OrderPricingForCreation'
        - properties:
            total:
              $ref: '#/components/schemas/OrderPricingTotal'
          type: object
      description: >
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Order pricing with customer-provided inputs and OMS-calculated totals.
      title: OrderPricing
      x-badges:
        - color: red
          label: ALPHA
    OrderPricingDiscount:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        code:
          description: Discount code
          type: string
        context:
          description: Context of the discount
          type: string
        name:
          description: Name of the discount
          type: string
        percentage:
          description: >-
            Discount percentage (0 to 100). Required when type is PERCENTAGE.
            Must be positive or zero (e.g. 10 for 10% off).
          format: float
          type: number
        tenantDiscountId:
          description: Tenant-specific discount identifier
          type: string
        type:
          description: >-
            Type of the discount. ABSOLUTE requires value, PERCENTAGE requires
            percentage.
          enum:
            - ABSOLUTE
            - PERCENTAGE
          type: string
        value:
          $ref: '#/components/schemas/MonetaryValue'
      type: object
      title: OrderPricingDiscount
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />OrderPricingDiscount
      x-badges:
        - color: red
          label: ALPHA
    OrderPricingFee:
      properties:
        name:
          description: Name of the fee
          type: string
        value:
          $ref: '#/components/schemas/MonetaryValue'
      type: object
      title: OrderPricingFee
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />OrderPricingFee
      x-badges:
        - color: red
          label: ALPHA
    OrderPricingForCreation:
      description: >
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Customer-provided order-level pricing inputs. All arrays are optional
        — if a pricing feature block is missing, OMS treats the feature as not
        relevant. On update, pricing uses partial-merge semantics: only the
        provided arrays are replaced, omitted arrays retain their previous
        values.
      properties:
        discounts:
          items:
            $ref: '#/components/schemas/OrderPricingDiscount'
          maxItems: 100
          type: array
        fees:
          items:
            $ref: '#/components/schemas/OrderPricingFee'
          maxItems: 100
          type: array
        taxes:
          items:
            $ref: '#/components/schemas/OrderPricingTax'
          maxItems: 100
          type: array
      type: object
      title: OrderPricingForCreation
      x-badges:
        - color: red
          label: ALPHA
    OrderPricingTax:
      properties:
        ratePercent:
          description: Tax rate as percentage
          type: number
        scope:
          description: Scope of the tax
          type: string
        taxableValue:
          $ref: '#/components/schemas/MonetaryValue'
        type:
          description: Tax type identifier
          type: string
        value:
          $ref: '#/components/schemas/MonetaryValue'
      required:
        - value
      type: object
      title: OrderPricingTax
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />OrderPricingTax
      x-badges:
        - color: red
          label: ALPHA
    OrderPricingTotal:
      properties:
        priceBreakdown:
          $ref: '#/components/schemas/OrderPricingTotals'
      type: object
      title: OrderPricingTotal
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />OrderPricingTotal
      x-badges:
        - color: red
          label: ALPHA
    OrderPricingTotals:
      description: >
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Calculated order price breakdown. All fields are optional — if a
        derived field cannot be calculated, it is omitted.
      properties:
        subTotal:
          allOf:
            - $ref: '#/components/schemas/MonetaryValue'
          nullable: true
          type: object
        total:
          allOf:
            - $ref: '#/components/schemas/MonetaryValue'
          nullable: true
          type: object
        totalDiscounts:
          allOf:
            - $ref: '#/components/schemas/OrderTotalDiscounts'
          nullable: true
          type: object
        totalFees:
          allOf:
            - $ref: '#/components/schemas/MonetaryValue'
          nullable: true
          type: object
        totalLineItemSurcharges:
          allOf:
            - $ref: '#/components/schemas/MonetaryValue'
          nullable: true
          type: object
        totalTaxes:
          allOf:
            - $ref: '#/components/schemas/MonetaryValue'
          nullable: true
          type: object
      type: object
      title: OrderPricingTotals
      x-badges:
        - color: red
          label: ALPHA
    OrderPromisesOptions:
      additionalProperties: false
      properties:
        validUntil:
          description: >-
            The date and time at which the promised order expires and is
            automatically cancelled if not converted into an actual order. Must
            be between 1 minute and 8 hours from now.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - validUntil
      type: object
      xml:
        name: OrderPromisesOptions
      title: OrderPromisesOptions
      description: OrderPromisesOptions
    OrderRatingDecision:
      properties:
        details:
          items:
            anyOf:
              - $ref: '#/components/schemas/ToolkitDecisionDetail'
              - $ref: '#/components/schemas/ToolkitComparisonDecisionDetail'
          type: array
        maxPenalty:
          type: number
        name:
          type: string
        normalizedScore:
          type: number
        score:
          type: number
      required:
        - name
        - normalizedScore
        - maxPenalty
      type: object
      title: OrderRatingDecision
      description: OrderRatingDecision
    OrderRecord:
      properties:
        anonymized:
          description: Whether consumer data has been anonymized
          type: boolean
        consumer:
          allOf:
            - $ref: '#/components/schemas/OrderRecordConsumer'
          description: Consumer information
        created:
          description: Creation timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        deletionDate:
          description: Date when the record will be deleted
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        facilityRef:
          description: Reference to the facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        gdprCleanupDate:
          description: Date when GDPR cleanup will occur
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        id:
          description: Unique identifier of the order record
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Last modification timestamp
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        lineItems:
          description: Line items of the order record
          items:
            $ref: '#/components/schemas/OrderRecordLineItem'
          maxItems: 500
          type: array
        orderRecordDate:
          description: Date of the order record
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        origin:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPosOrigin'
          description: Origin of the order record
          discriminator:
            mapping:
              POS: '#/components/schemas/OrderRecordPosOrigin'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/OrderRecordPosOrigin'
        payments:
          description: Payment information
          items:
            $ref: '#/components/schemas/OrderRecordPayment'
          maxItems: 100
          type: array
        pricing:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPricing'
          description: Pricing information including calculated totals
        tenantOrderRecordId:
          description: Tenant-specific order record identifier
          example: MY_ORDERRECORD_ID
          type: string
        version:
          description: Version number for optimistic locking
          example: 1
          type: integer
      required:
        - orderRecordDate
        - facilityRef
        - lineItems
        - id
        - version
        - created
        - lastModified
        - anonymized
        - gdprCleanupDate
        - deletionDate
      title: OrderRecord
      type: object
      description: OrderRecord
    OrderRecordAddress:
      properties:
        additionalAddressInfo:
          description: Additional address information
          type: string
        city:
          description: City
          example: Yellowstone
          type: string
        companyName:
          description: Company name
          type: string
        country:
          description: Country
          example: US
          type: string
        firstName:
          description: First name
          type: string
        houseNumber:
          description: House number
          example: 42
          type: string
        lastName:
          description: Last name
          type: string
        postalCode:
          description: Postal code
          example: '42420'
          type: string
        province:
          description: Province or state
          type: string
        street:
          description: Street
          type: string
      title: OrderRecordAddress
      type: object
      description: OrderRecordAddress
    OrderRecordAddressesSort:
      properties:
        city:
          enum:
            - ASC
            - DESC
          type: string
        companyName:
          enum:
            - ASC
            - DESC
          type: string
        country:
          enum:
            - ASC
            - DESC
          type: string
        firstName:
          enum:
            - ASC
            - DESC
          type: string
        lastName:
          enum:
            - ASC
            - DESC
          type: string
        postalCode:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderRecordAddressesSort
      type: object
      description: OrderRecordAddressesSort
    OrderRecordArticleAttributeItem:
      properties:
        valueLocalized:
          description: Localized value of the attribute
          type: object
        keyLocalized:
          description: Localized key of the attribute
          type: object
        category:
          description: >-
            Category of the attribute. Supports both standard article attribute
            categories and pricing-specific categories.
          enum:
            - descriptive
            - miscellaneous
            - pickingSequence
            - customs
            - insurance
            - shop
            - dimensions
            - carrierService
            - salesPrice
            - basePrice
            - tax
            - discount
            - surcharge
            - subtotalBeforeDiscounts
            - subtotalAfterDiscounts
            - finalUnitPrice
            - finalLineItemPrice
          type: string
        key:
          description: The key of the attribute
          minLength: 1
          type: string
        priority:
          description: Priority of the attribute
          example: 42
          type: integer
        type:
          description: The type of the attribute
          enum:
            - STRING
            - NUMBER
            - CURRENCY
            - BOOLEAN
          type: string
        value:
          description: The value of the attribute
          minLength: 1
          type: string
      required:
        - key
        - value
      title: OrderRecordArticleAttributeItem
      type: object
      description: OrderRecordArticleAttributeItem
    OrderRecordBulkOperationError:
      properties:
        message:
          description: Error message
          type: string
        type:
          description: Error type
          enum:
            - VALIDATION
            - UNKNOWN
          type: string
      required:
        - type
        - message
      title: OrderRecordBulkOperationError
      type: object
      description: OrderRecordBulkOperationError
    OrderRecordBulkOperationResult:
      properties:
        error:
          allOf:
            - $ref: '#/components/schemas/OrderRecordBulkOperationError'
          description: Error details if the operation failed
        orderRecord:
          allOf:
            - $ref: '#/components/schemas/OrderRecord'
          description: The created order record
        status:
          description: Status of the bulk operation
          enum:
            - CREATED
            - FAILED
            - UNCHANGED
          type: string
      required:
        - status
      title: OrderRecordBulkOperationResult
      type: object
      description: OrderRecordBulkOperationResult
    OrderRecordBulkOperations:
      properties:
        operations:
          description: Array of order record creation operations
          items:
            $ref: '#/components/schemas/OrderRecordForCreation'
          maxItems: 25
          minItems: 1
          type: array
      required:
        - operations
      title: OrderRecordBulkOperations
      type: object
      description: OrderRecordBulkOperations
    OrderRecordBulkOperationsResponse:
      properties:
        details:
          description: Per-item results of the bulk operation
          items:
            $ref: '#/components/schemas/OrderRecordBulkOperationResult'
          maxItems: 25
          type: array
        summary:
          allOf:
            - $ref: '#/components/schemas/OrderRecordBulkOperationsSummary'
          description: Summary of the bulk operation
      required:
        - summary
        - details
      title: OrderRecordBulkOperationsResponse
      type: object
      description: OrderRecordBulkOperationsResponse
    OrderRecordBulkOperationsSummary:
      properties:
        created:
          description: Number of order records created
          example: 42
          type: integer
        unchanged:
          description: Number of order records unchanged
          example: 42
          type: integer
        updated:
          description: Number of order records updated
          example: 2026-06-17T12:00:00.000Z
          type: integer
      required:
        - created
        - updated
        - unchanged
      title: OrderRecordBulkOperationsSummary
      type: object
      description: OrderRecordBulkOperationsSummary
    OrderRecordConsumer:
      properties:
        addresses:
          description: Addresses of the consumer
          items:
            $ref: '#/components/schemas/OrderRecordAddress'
          maxItems: 10
          type: array
        consumerId:
          description: Consumer identifier
          type: string
        email:
          description: Email address of the consumer
          example: phil.bison@fulfillmenttools.com
          type: string
      title: OrderRecordConsumer
      type: object
      description: OrderRecordConsumer
    OrderRecordConsumerAddressesFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by companyName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by lastName
      title: OrderRecordConsumerAddressesFilter
      type: object
      description: OrderRecordConsumerAddressesFilter
    OrderRecordConsumerAddressesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderRecordConsumerAddressesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderRecordConsumerAddressesListFilter
      type: object
      description: OrderRecordConsumerAddressesListFilter
    OrderRecordConsumerFilter:
      properties:
        addresses:
          allOf:
            - $ref: '#/components/schemas/OrderRecordConsumerAddressesListFilter'
          description: Nested list search by addresses
        consumerId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by consumerId
      title: OrderRecordConsumerFilter
      type: object
      description: OrderRecordConsumerFilter
    OrderRecordConsumerSort:
      properties:
        addresses:
          $ref: '#/components/schemas/OrderRecordAddressesSort'
      title: OrderRecordConsumerSort
      type: object
      description: OrderRecordConsumerSort
    OrderRecordDiscount:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleStringConstrained'
          description: Localized name of the discount
        code:
          description: Discount code
          type: string
        context:
          description: Context of the discount
          type: string
        name:
          description: Name of the discount
          type: string
        percentage:
          description: Discount percentage (0-100). Required when type is PERCENTAGE.
          type: number
        tenantDiscountId:
          description: Tenant-specific discount identifier
          example: MY_DISCOUNT_ID
          type: string
        type:
          description: Discount type
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Discount value. Required when type is ABSOLUTE.
      title: OrderRecordDiscount
      type: object
      description: OrderRecordDiscount
    OrderRecordDiscountBreakdown:
      properties:
        lineItemDiscounts:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Discounts originating from line items
          nullable: true
          type: object
        orderDiscounts:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Discounts applied at order level
          nullable: true
          type: object
      required:
        - lineItemDiscounts
        - orderDiscounts
      title: OrderRecordDiscountBreakdown
      type: object
      description: OrderRecordDiscountBreakdown
    OrderRecordFee:
      properties:
        name:
          description: Name of the fee
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Fee value
      title: OrderRecordFee
      type: object
      description: OrderRecordFee
    OrderRecordForCreation:
      properties:
        consumer:
          allOf:
            - $ref: '#/components/schemas/OrderRecordConsumer'
          description: Consumer information
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: Reference to the facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lineItems:
          description: Line items of the order record
          items:
            $ref: '#/components/schemas/OrderRecordLineItemForCreation'
          maxItems: 500
          type: array
        orderRecordDate:
          description: Date of the order record
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        origin:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPosOrigin'
          description: Origin of the order record
          discriminator:
            mapping:
              POS: '#/components/schemas/OrderRecordPosOrigin'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/OrderRecordPosOrigin'
        payments:
          description: Payment information
          items:
            $ref: '#/components/schemas/OrderRecordPayment'
          maxItems: 100
          type: array
        pricing:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPricingForCreation'
          description: Pricing information for the order record
        tenantOrderRecordId:
          description: Tenant-specific order record identifier
          example: MY_ORDERRECORD_ID
          type: string
      required:
        - orderRecordDate
        - facilityRef
        - lineItems
      title: OrderRecordForCreation
      type: object
      description: OrderRecordForCreation
    OrderRecordLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemArticle'
          description: Article information
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          description: Unique identifier of the line item
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        measurementUnitKey:
          description: Measurement unit key
          type: string
        quantity:
          description: Quantity of the line item
          example: 42
          type: number
        returnPolicy:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemReturnPolicy'
          description: Return policy information
        warranty:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemWarranty'
          description: Warranty information
      required:
        - article
        - quantity
        - id
      title: OrderRecordLineItem
      type: object
      description: OrderRecordLineItem
    OrderRecordLineItemArticle:
      properties:
        attributes:
          description: Article attributes
          items:
            $ref: '#/components/schemas/OrderRecordArticleAttributeItem'
          maxItems: 100
          type: array
        tenantArticleId:
          description: Tenant-specific article identifier
          example: MY_ARTICLE_ID
          type: string
        title:
          description: Title of the article
          type: string
      required:
        - tenantArticleId
        - attributes
      title: OrderRecordLineItemArticle
      type: object
      description: OrderRecordLineItemArticle
    OrderRecordLineItemForCreation:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemArticle'
          description: Article information
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        measurementUnitKey:
          description: Measurement unit key
          type: string
        quantity:
          description: Quantity of the line item
          example: 42
          type: number
        returnPolicy:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemReturnPolicy'
          description: Return policy information
        warranty:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemWarranty'
          description: Warranty information
      required:
        - article
        - quantity
      title: OrderRecordLineItemForCreation
      type: object
      description: OrderRecordLineItemForCreation
    OrderRecordLineItemReturnPolicy:
      properties:
        isReturnable:
          description: Whether the item is returnable
          type: boolean
        returnWindowEndDate:
          description: End date of the return window
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      title: OrderRecordLineItemReturnPolicy
      type: object
      description: OrderRecordLineItemReturnPolicy
    OrderRecordLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
      title: OrderRecordLineItemsArticleFilter
      type: object
      description: OrderRecordLineItemsArticleFilter
    OrderRecordLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemsArticleFilter'
          description: Nested search by article
      title: OrderRecordLineItemsFilter
      type: object
      description: OrderRecordLineItemsFilter
    OrderRecordLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderRecordLineItemsListFilter
      type: object
      description: OrderRecordLineItemsListFilter
    OrderRecordLineItemsSort:
      properties:
        quantity:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderRecordLineItemsSort
      type: object
      description: OrderRecordLineItemsSort
    OrderRecordLineItemWarranty:
      properties:
        warrantyPeriod:
          description: Warranty period (e.g. ISO 8601 duration)
          pattern: ^-?P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
        warrantyStartDate:
          description: Start date of the warranty
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      title: OrderRecordLineItemWarranty
      type: object
      description: OrderRecordLineItemWarranty
    OrderRecordMonetaryValue:
      properties:
        currency:
          description: ISO 4217 currency code
          enum:
            - AED
            - AFN
            - ALL
            - AMD
            - ANG
            - AOA
            - ARS
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - BMD
            - BND
            - BOB
            - BOV
            - BRL
            - BSD
            - BTN
            - BWP
            - BYN
            - BZD
            - CAD
            - CDF
            - CHE
            - CHF
            - CHW
            - CLF
            - CLP
            - CNY
            - COP
            - COU
            - CRC
            - CUC
            - CUP
            - CVE
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - ERN
            - ETB
            - EUR
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LYD
            - MAD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRU
            - MUR
            - MVR
            - MWK
            - MXN
            - MXV
            - MYR
            - MZN
            - NAD
            - NGN
            - NIO
            - NOK
            - NPR
            - NZD
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLE
            - SOS
            - SRD
            - SSP
            - STN
            - SVC
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - USD
            - USN
            - UYI
            - UYU
            - UYW
            - UZS
            - VED
            - VES
            - VND
            - VUV
            - WST
            - XAF
            - XAG
            - XAU
            - XBA
            - XBB
            - XBC
            - XBD
            - XCD
            - XDR
            - XOF
            - XPD
            - XPF
            - XPT
            - XSU
            - XTS
            - XUA
            - XXX
            - YER
            - ZAR
            - ZMW
            - ZWL
          type: string
        decimalPlaces:
          description: Number of decimal places (defaults to currency standard)
          example: 42
          type: integer
        value:
          description: The monetary value as integer
          example: 42
          type: integer
      required:
        - value
        - currency
      title: OrderRecordMonetaryValue
      type: object
      description: OrderRecordMonetaryValue
    OrderRecordOriginFilter:
      properties:
        cashierId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by cashierId
        terminalId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by terminalId
      title: OrderRecordOriginFilter
      type: object
      description: OrderRecordOriginFilter
    OrderRecordOriginSort:
      properties:
        cashierId:
          enum:
            - ASC
            - DESC
          type: string
        terminalId:
          enum:
            - ASC
            - DESC
          type: string
        type:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderRecordOriginSort
      type: object
      description: OrderRecordOriginSort
    OrderRecordPaginatedResult:
      properties:
        orderRecords:
          items:
            $ref: '#/components/schemas/OrderRecord'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - orderRecords
      title: OrderRecordPaginatedResult
      type: object
      description: OrderRecordPaginatedResult
    OrderRecordPayment:
      properties:
        paymentMethod:
          description: Payment method identifier
          type: string
        receiptNumber:
          description: Receipt number
          type: string
        status:
          description: Status of the payment
          enum:
            - COMPLETED
            - FAILED
            - CANCELLED
            - REFUNDED
            - PARTIALLY_REFUNDED
          type: string
        taxValue:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Tax portion of the payment value
        transactionId:
          description: Transaction identifier
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Payment value
      required:
        - value
      title: OrderRecordPayment
      type: object
      description: OrderRecordPayment
    OrderRecordPaymentsFilter:
      properties:
        receiptNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by receiptNumber
        transactionId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by transactionId
      title: OrderRecordPaymentsFilter
      type: object
      description: OrderRecordPaymentsFilter
    OrderRecordPaymentsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPaymentsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderRecordPaymentsListFilter
      type: object
      description: OrderRecordPaymentsListFilter
    OrderRecordPaymentsSort:
      properties:
        paymentMethod:
          enum:
            - ASC
            - DESC
          type: string
        receiptNumber:
          enum:
            - ASC
            - DESC
          type: string
        status:
          enum:
            - ASC
            - DESC
          type: string
        transactionId:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderRecordPaymentsSort
      type: object
      description: OrderRecordPaymentsSort
    OrderRecordPosOrigin:
      properties:
        cashierId:
          description: Cashier identifier
          type: string
        terminalId:
          description: Terminal identifier
          type: string
        type:
          description: Discriminator for POS origin
          enum:
            - POS
          type: string
      required:
        - type
      title: OrderRecordPosOrigin
      type: object
      description: OrderRecordPosOrigin
    OrderRecordPricing:
      properties:
        discounts:
          description: Discounts applied to the order
          items:
            $ref: '#/components/schemas/OrderRecordDiscount'
          maxItems: 100
          type: array
        fees:
          description: Fees applied to the order
          items:
            $ref: '#/components/schemas/OrderRecordFee'
          maxItems: 100
          type: array
        taxes:
          description: Tax breakdown
          items:
            $ref: '#/components/schemas/OrderRecordTax'
          maxItems: 100
          type: array
        total:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPricingTotal'
          description: Calculated totals
      title: OrderRecordPricing
      type: object
      description: OrderRecordPricing
    OrderRecordPricingForCreation:
      properties:
        discounts:
          description: Discounts applied to the order
          items:
            $ref: '#/components/schemas/OrderRecordDiscount'
          maxItems: 100
          type: array
        fees:
          description: Fees applied to the order
          items:
            $ref: '#/components/schemas/OrderRecordFee'
          maxItems: 100
          type: array
        taxes:
          description: Tax breakdown
          items:
            $ref: '#/components/schemas/OrderRecordTax'
          maxItems: 100
          type: array
      title: OrderRecordPricingForCreation
      type: object
      description: OrderRecordPricingForCreation
    OrderRecordPricingSort:
      properties:
        total:
          $ref: '#/components/schemas/OrderRecordTotalSort'
      title: OrderRecordPricingSort
      type: object
      description: OrderRecordPricingSort
    OrderRecordPricingTotal:
      properties:
        priceBreakdown:
          allOf:
            - $ref: '#/components/schemas/OrderRecordTotals'
          description: Calculated price breakdown
      title: OrderRecordPricingTotal
      type: object
      description: OrderRecordPricingTotal
    OrderRecords:
      properties:
        orderRecords:
          description: Array of order records
          items:
            $ref: '#/components/schemas/OrderRecord'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: number
      required:
        - orderRecords
        - total
      title: OrderRecords
      type: object
      description: OrderRecords
    OrderRecordsConfiguration:
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Configuration for the order records functionality.
      properties:
        created:
          description: Creation timestamp.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        id:
          description: Unique identifier of the order record config.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        isOrderRecordsEnabled:
          default: false
          description: Flag indicating whether order records functionality is enabled.
          type: boolean
        lastModified:
          description: Last modification timestamp.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        version:
          description: >-
            The version of the configuration to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - id
        - version
        - isOrderRecordsEnabled
      title: OrderRecordsConfiguration
      type: object
      x-badges:
        - color: red
          label: ALPHA
    OrderRecordsConfigurationInput:
      properties:
        isOrderRecordsEnabled:
          default: false
          description: Flag indicating whether order records functionality is enabled.
          type: boolean
        version:
          description: Version number for optimistic locking.
          example: 1
          format: int64
          type: integer
      required:
        - version
        - isOrderRecordsEnabled
      title: OrderRecordsConfigurationInput
      type: object
      description: OrderRecordsConfigurationInput
    OrderRecordSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/OrderRecordSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/OrderRecordSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: OrderRecordSearchPayload
      type: object
      description: OrderRecordSearchPayload
    OrderRecordSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/OrderRecordSearchQuery'
          maxItems: 500
          type: array
        consumer:
          allOf:
            - $ref: '#/components/schemas/OrderRecordConsumerFilter'
          description: Nested search by consumer
        facilityName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityName
        lineItems:
          allOf:
            - $ref: '#/components/schemas/OrderRecordLineItemsListFilter'
          description: Nested list search by lineItems
        or:
          items:
            $ref: '#/components/schemas/OrderRecordSearchQuery'
          maxItems: 500
          type: array
        orderRecordDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by orderRecordDate
          example: 2026-06-17T12:00:00.000Z
        origin:
          allOf:
            - $ref: '#/components/schemas/OrderRecordOriginFilter'
          description: Nested search by origin
        payments:
          allOf:
            - $ref: '#/components/schemas/OrderRecordPaymentsListFilter'
          description: Nested list search by payments
        tenantOrderRecordId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderRecordId
          example: MY_ORDERRECORD_ID
      title: OrderRecordSearchQuery
      type: object
      description: OrderRecordSearchQuery
    OrderRecordSort:
      properties:
        consumer:
          $ref: '#/components/schemas/OrderRecordConsumerSort'
        facilityCountry:
          enum:
            - ASC
            - DESC
          type: string
        facilityName:
          enum:
            - ASC
            - DESC
          type: string
        lineItems:
          $ref: '#/components/schemas/OrderRecordLineItemsSort'
        orderRecordDate:
          enum:
            - ASC
            - DESC
          type: string
        origin:
          $ref: '#/components/schemas/OrderRecordOriginSort'
        payments:
          $ref: '#/components/schemas/OrderRecordPaymentsSort'
        pricing:
          $ref: '#/components/schemas/OrderRecordPricingSort'
        tenantOrderRecordId:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderRecordSort
      type: object
      description: OrderRecordSort
    OrderRecordTax:
      properties:
        ratePercent:
          description: Tax rate as a percentage
          example: 42
          format: float
          type: number
        scope:
          description: Tax scope
          type: string
        taxableValue:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: The taxable base value
        type:
          description: Tax type identifier
          type: string
        value:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Tax value
      required:
        - value
      title: OrderRecordTax
      type: object
      description: OrderRecordTax
    OrderRecordTotalDiscounts:
      properties:
        breakdown:
          allOf:
            - $ref: '#/components/schemas/OrderRecordDiscountBreakdown'
          description: Total discounts broken down by source
        value:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Aggregate total discounts applied
          nullable: true
          type: object
      required:
        - value
        - breakdown
      title: OrderRecordTotalDiscounts
      type: object
      description: OrderRecordTotalDiscounts
    OrderRecordTotals:
      properties:
        subTotal:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Subtotal before discounts, taxes, and fees
          nullable: true
          type: object
        total:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Grand total
          nullable: true
          type: object
        totalDiscounts:
          allOf:
            - $ref: '#/components/schemas/OrderRecordTotalDiscounts'
          description: Total discounts applied, with breakdown by source
          nullable: true
          type: object
        totalFees:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Total fees
          nullable: true
          type: object
        totalLineItemSurcharges:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Total line item surcharges applied
          nullable: true
          type: object
        totalTaxes:
          allOf:
            - $ref: '#/components/schemas/OrderRecordMonetaryValue'
          description: Total taxes
          nullable: true
          type: object
      required:
        - subTotal
        - totalDiscounts
        - totalLineItemSurcharges
        - totalTaxes
        - totalFees
        - total
      title: OrderRecordTotals
      type: object
      description: OrderRecordTotals
    OrderRecordTotalSort:
      properties:
        priceBreakdownTotal:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderRecordTotalSort
      type: object
      description: OrderRecordTotalSort
    OrderRoutingConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        infiniteStockEnabled:
          description: Config to enable/disable infinite stock
          type: boolean
      type: object
      title: OrderRoutingConfiguration
      description: OrderRoutingConfiguration
    OrderSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/OrderSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/OrderSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: OrderSearchPayload
      type: object
      description: OrderSearchPayload
    OrderSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/OrderSearchQuery'
          maxItems: 500
          type: array
        consumer:
          allOf:
            - $ref: '#/components/schemas/OrderConsumerFilter'
          description: Nested search by consumer
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        deliveryPreferences:
          allOf:
            - $ref: '#/components/schemas/OrderDeliveryPreferencesFilter'
          description: Nested search by deliveryPreferences
        or:
          items:
            $ref: '#/components/schemas/OrderSearchQuery'
          maxItems: 500
          type: array
        orderDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by orderDate. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
          example: 2026-06-17T12:00:00.000Z
        orderLineItems:
          allOf:
            - $ref: '#/components/schemas/OrderOrderLineItemsListFilter'
          description: Nested list search by orderLineItems
        paymentInfo:
          allOf:
            - $ref: '#/components/schemas/OrderPaymentInfoFilter'
          description: Nested search by paymentInfo
        status:
          allOf:
            - $ref: '#/components/schemas/OrderStatusEnumFilter'
          description: Search by status
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
        tags:
          allOf:
            - $ref: '#/components/schemas/OrderTagsListFilter'
          description: Nested list search by tags
      title: OrderSearchQuery
      type: object
      description: OrderSearchQuery
    OrderSort:
      properties:
        orderDate:
          enum:
            - ASC
            - DESC
          type: string
        status:
          enum:
            - ASC
            - DESC
          type: string
      title: OrderSort
      type: object
      description: OrderSort
    OrderSourceConfiguration:
      additionalProperties: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        configuration is to define possible sources of an order
      properties:
        created:
          description: >-
            The date this configuration was created at the platform. This value
            is generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          type: string
        lastModified:
          description: >-
            The date the config was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        orderSources:
          items:
            $ref: '#/components/schemas/OrderSourceEntry'
          maxItems: 500
          minItems: 0
          type: array
        version:
          description: >-
            The version of the configuration to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      title: OrderSourceConfiguration
      x-badges:
        - color: red
          label: ALPHA
    OrderSourceEntry:
      additionalProperties: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Possible source of an order
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        id:
          type: string
        name:
          type: string
        tenantSourceId:
          type: string
        version:
          type: integer
      required:
        - nameLocalized
        - version
        - id
      type: object
      title: OrderSourceEntry
      x-badges:
        - color: red
          label: ALPHA
    OrderSourceEntryForCreation:
      additionalProperties: false
      description: >-
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Possible source of an order
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        tenantSourceId:
          type: string
      required:
        - nameLocalized
      type: object
      title: OrderSourceEntryForCreation
      x-badges:
        - color: red
          label: ALPHA
    OrderSourceEntryForUpdate:
      additionalProperties: false
      description: >-
        Possible source of an order, used for update operations, where the
        version is required for optimistic locking
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        tenantSourceId:
          type: string
        version:
          type: integer
      required:
        - nameLocalized
        - version
      type: object
      title: OrderSourceEntryForUpdate
    OrderSplit:
      additionalProperties: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />
      properties:
        active:
          default: false
          type: boolean
        activeForSameDay:
          default: false
          type: boolean
        fixedCountConfiguration:
          $ref: '#/components/schemas/FixedCountConfiguration'
        orderSplitType:
          $ref: '#/components/schemas/OrderSplitType'
        shouldUseWaitingRoomForPreBackOrderItems:
          default: false
          type: boolean
      required:
        - active
        - orderSplitType
      type: object
      title: OrderSplit
      x-badges:
        - color: orange
          label: BETA
    OrderSplitDecision:
      properties:
        reassignment:
          $ref: '#/components/schemas/ReassignmentInformation'
        split:
          $ref: '#/components/schemas/SplitInformation'
        splitType:
          $ref: '#/components/schemas/SplitResultType'
      required:
        - splitType
      title: OrderSplitDecision
      description: OrderSplitDecision
    OrderSplitType:
      description: The type of order split
      enum:
        - FIXED_COUNT
      type: string
      xml:
        name: OrderSplitType
      title: OrderSplitType
    OrderStatus:
      description: The state of the order. Initially it is OPEN.
      enum:
        - OPEN
        - CANCELLED
        - PROMISED
        - LOCKED
        - OBSOLETE
      type: string
      title: OrderStatus
    OrderStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - CANCELLED
              - PROMISED
              - LOCKED
              - OBSOLETE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
      title: OrderStatusEnumFilter
      type: object
      description: OrderStatusEnumFilter
    OrderStatusReason:
      description: Order Status Reason.
      properties:
        reason:
          description: The reason for setting this order status
          type: string
        status:
          $ref: '#/components/schemas/OrderStatus'
      required:
        - reason
        - status
      title: OrderStatusReason
    OrderStatusReasonLog:
      properties:
        reason:
          type: string
        status:
          $ref: '#/components/schemas/OrderStatus'
      type: object
      title: OrderStatusReasonLog
      description: OrderStatusReasonLog
    OrderTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagConfiguration'
      properties:
        stickerConfiguration:
          $ref: '#/components/schemas/StickerConfiguration'
      title: OrderTagConfiguration
      description: OrderTagConfiguration
    OrderTagsFilter:
      properties:
        value:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by value
      title: OrderTagsFilter
      type: object
      description: OrderTagsFilter
    OrderTagsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/OrderTagsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: OrderTagsListFilter
      type: object
      description: OrderTagsListFilter
    OrderTotalDiscounts:
      description: >
        This part of the API is in Alpha status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Aggregate discount total with a breakdown by source. Values follow the
        negative-or-zero discount convention.
      properties:
        breakdown:
          properties:
            lineItemDiscounts:
              allOf:
                - $ref: '#/components/schemas/MonetaryValue'
              nullable: true
              type: object
            orderDiscounts:
              allOf:
                - $ref: '#/components/schemas/MonetaryValue'
              nullable: true
              type: object
          type: object
        value:
          allOf:
            - $ref: '#/components/schemas/MonetaryValue'
          nullable: true
          type: object
      type: object
      title: OrderTotalDiscounts
      x-badges:
        - color: red
          label: ALPHA
    OrderUnlockActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      description: Action to unlock an order.
      properties:
        name:
          enum:
            - UNLOCK
          type: string
        targetTime:
          description: Time to be set as a targetTime for the devlivery preferences.
          example: 2025-01-15T00:00:00.000Z
          format: date-time
          type: string
      required:
        - name
        - version
      title: OrderUnlockActionParameter
    OrderUnlockedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Order'
      required:
        - payload
      type: object
      title: OrderUnlockedWebHookEvent
      description: OrderUnlockedWebHookEvent
    OrderUpdateDetail:
      properties:
        changes:
          $ref: '#/components/schemas/OrderUpdateDetailChanges'
        comment:
          type: string
        created:
          description: The date this update was done.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        user:
          type: string
      required:
        - created
        - changes
      type: object
      title: OrderUpdateDetail
      description: OrderUpdateDetail
    OrderUpdateDetailChanges:
      properties:
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
        customAttributes:
          description: >-
            Attributes that can be added to the order. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          nullable: true
          type: object
        orderLineItems:
          description: >-
            Updates the order line items of the order. All order lines must be
            included, only the included lines will remain after the update.
          items:
            $ref: '#/components/schemas/OrderLineItemForUpdate'
          nullable: true
          type: array
        preferredHandlingTime:
          description: >-
            Updates the preferred handling time for ship-from-store orders or
            the provisioning time for click-and-collect orders.
          example: 2025-01-15T00:00:00.000Z
          format: date-time
          type: string
      type: object
      title: OrderUpdateDetailChanges
      description: OrderUpdateDetailChanges
    OutboundClearTrigger:
      properties:
        event:
          enum:
            - pick-job-closed_event-v1
            - handoverjob-handed-over_event-v1
          type: string
        tagFilter:
          items:
            $ref: '#/components/schemas/OutboundTagFilter'
          type: array
      required:
        - event
      title: OutboundClearTrigger
      type: object
      description: OutboundClearTrigger
    OutboundStockConfiguration:
      properties:
        clearTrigger:
          items:
            $ref: '#/components/schemas/OutboundClearTrigger'
          type: array
        locationRef:
          type: string
        trackOutboundStock:
          type: boolean
      required:
        - trackOutboundStock
        - locationRef
      title: OutboundStockConfiguration
      type: object
      description: OutboundStockConfiguration
    OutboundTagFilter:
      properties:
        allowedValues:
          items:
            type: string
          type: array
        tagId:
          type: string
      required:
        - allowedValues
        - tagId
      title: OutboundTagFilter
      type: object
      description: OutboundTagFilter
    OutOfStockBehaviour:
      description: >-
        The PREORDER and RESTOCK can be only set, when the depending
        outOfStockConfig is provided.

        Also PREORDER and RESTOCK values are in Alpha status. For details please
        check the <a
        href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#alpha"
        target="_blank">api-release-life-cycle documentation</a>.<br /><br />
      enum:
        - NONE
        - BACKORDER
        - PREORDER
        - RESTOCK
        - PREORDER_AND_RESTOCK
      type: string
      title: OutOfStockBehaviour
    OutOfStockBehaviourByContext:
      additionalProperties: false
      properties:
        context:
          description: >-
            The context of the outOfStockBehaviour. This is used to determine
            the conditions under which the outOfStockBehaviour can be applied.

            For details please check the <a
            href="https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/context"
            target="_blank">context documentation</a>.
          items:
            $ref: '#/components/schemas/OutOfStockBehaviourContext'
            maxItems: 5
            minItems: 1
          type: array
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        outOfStockConfig:
          $ref: '#/components/schemas/OutOfStockConfig'
        priority:
          description: >-
            This value gives the priority in the respective
            OutOfStockBehaviourByContexts. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10. The priority
            can be used to order OutOfStockBehaviourByContexts.
          example: 100
          format: int32
          maximum: 1000
          minimum: 1
          type: integer
      required:
        - outOfStockBehaviour
        - context
        - priority
      type: object
      title: OutOfStockBehaviourByContext
      description: OutOfStockBehaviourByContext
    OutOfStockBehaviourByContext2:
      properties:
        context:
          description: >-
            The OutOfStockBehaviourByContexts is in Alpha status. For details,
            see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br/>
          items:
            $ref: '#/components/schemas/OutOfStockBehaviourContext'
          maxItems: 5
          minItems: 1
          type: array
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        outOfStockConfig:
          $ref: '#/components/schemas/OutOfStockConfig2'
        priority:
          type: number
      required:
        - outOfStockBehaviour
        - context
        - priority
      title: OutOfStockBehaviourByContext2
      type: object
      description: OutOfStockBehaviourByContext2
    OutOfStockBehaviourContext:
      additionalProperties: false
      description: >-
        The context of the outOfStockBehaviour. This is used to determine the
        conditions under which the outOfStockBehaviour can be applied.
      properties:
        operator:
          $ref: '#/components/schemas/ContextOperator'
        type:
          $ref: '#/components/schemas/OutOfStockBehaviourContextType'
        values:
          description: >-
            The values of the context. This is used to determine the conditions
            under which the outOfStockBehaviour can be applied.
          items:
            example: uuid-bkrs-0157
            maxItems: 100
            minItems: 0
            type: string
          type: array
      required:
        - type
        - values
      type: object
      title: OutOfStockBehaviourContext
    OutOfStockBehaviourContextType:
      description: >-
        The context type of the OutOfStockBehaviourContext. This is used to
        determine the conditions under which the outOfStockBehaviour can be
        applied.
      enum:
        - FACILITY_GROUP
        - TAG_REFERENCE
      type: string
      title: OutOfStockBehaviourContextType
    OutOfStockConfig:
      additionalProperties: false
      properties:
        preorder:
          properties:
            availabilityTimeframe:
              $ref: '#/components/schemas/AvailabilityTimeframe'
          required:
            - availabilityTimeframe
          type: object
        restock:
          properties:
            restockableInDays:
              type: integer
          required:
            - restockableInDays
          type: object
      type: object
      title: OutOfStockConfig
      description: OutOfStockConfig
    OutOfStockConfig2:
      properties:
        preorder:
          $ref: '#/components/schemas/OutOfStockConfigPreorder2'
        restock:
          $ref: '#/components/schemas/InventoryOutOfStockConfigRestock'
      title: OutOfStockConfig2
      type: object
      description: OutOfStockConfig2
    OutOfStockConfigPreorder2:
      properties:
        availabilityTimeframe:
          allOf:
            - $ref: '#/components/schemas/AvailabilityTimeframe2'
          example: 2026-06-17T12:00:00.000Z
      required:
        - availabilityTimeframe
      title: OutOfStockConfigPreorder2
      type: object
      description: OutOfStockConfigPreorder2
    PackageCost:
      additionalProperties: false
      properties:
        costAmount:
          $ref: '#/components/schemas/Money'
          description: The total package cost amount
        packageName:
          description: Name of the package
          example: Small Box
          type: string
      required:
        - packageName
        - costAmount
      type: object
      title: PackageCost
      description: PackageCost
    PackagingPricingDetails:
      properties:
        costCoefficient:
          allOf:
            - $ref: '#/components/schemas/PackagingUnitCostCoefficient'
          description: Cost coefficient for two-man handling
        pricing:
          items:
            $ref: '#/components/schemas/PackagingUnitDetailPricingByZone'
          maxItems: 500
          type: array
        surchargesPerPackagingUnits:
          description: The surcharge applied per packagingUnit.
          items:
            discriminator:
              mapping:
                ABSOLUTE_SURCHARGE_TYPE: '#/components/schemas/PackagingUnitDetailAbsoluteSurcharge'
                RELATIVE_SURCHARGE_TYPE: '#/components/schemas/PackagingUnitDetailRelativeSurcharge'
              propertyName: type
            oneOf:
              - $ref: '#/components/schemas/PackagingUnitDetailRelativeSurcharge'
              - $ref: '#/components/schemas/PackagingUnitDetailAbsoluteSurcharge'
          maxItems: 500
          type: array
      required:
        - pricing
      title: PackagingPricingDetails
      type: object
      description: PackagingPricingDetails
    PackagingUnit:
      additionalProperties: false
      properties:
        dimensions:
          $ref: '#/components/schemas/PackagingUnitDimensions'
        maxItemQuantity:
          description: The maximum item quantity of the packaging unit
          example: 10
          minimum: 0
          type: integer
        name:
          description: The name of the packaging unit
          example: Parcel XXL
          type: string
        packagingUnitRef:
          description: The reference ID of the packaging unit
          type: string
        prices:
          items:
            $ref: '#/components/schemas/InterFacilityConnectionDeliveryCost'
          type: array
        priority:
          description: >-
            The priority of the packaging unit. Lowest value has the highest
            priority. Must be unique per context
          example: 1
          minimum: 0
          type: integer
        tenantPackagingUnitId:
          description: The tenant-specific ID of the packaging unit
          example: Parcel XXL
          type: string
        transitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
        volumeBufferInPercent:
          description: The volume buffer of PackagingUnit in percent
          example: 10
          minimum: 0
          type: integer
      required:
        - name
        - priority
      type: object
      title: PackagingUnit
      description: PackagingUnit
    PackagingUnitContext:
      additionalProperties: false
      properties:
        operator:
          $ref: '#/components/schemas/ContextOperator'
        type:
          $ref: '#/components/schemas/PackagingUnitContextTypes'
        values:
          items:
            maxItems: 2000
            minItems: 0
            type: string
          type: array
      required:
        - type
        - values
      type: object
      title: PackagingUnitContext
      description: PackagingUnitContext
    PackagingUnitContextTypes:
      enum:
        - TARGET_POSTALCODE
        - TARGET_COUNTRY
        - CATEGORY
      type: string
      title: PackagingUnitContextTypes
      description: PackagingUnitContextTypes
    PackagingUnitCostCoefficient:
      properties:
        measurementUnit:
          enum:
            - GRAM
            - CUBIC_METER
          type: string
        value:
          $ref: '#/components/schemas/PackagingUnitsMoney'
      required:
        - value
        - measurementUnit
      title: PackagingUnitCostCoefficient
      type: object
      description: PackagingUnitCostCoefficient
    PackagingUnitDetailAbsoluteSurcharge:
      properties:
        amount:
          $ref: '#/components/schemas/PackagingUnitsMoney'
        tenantSurchargeType:
          description: The tenant specific identifier for the surcharge type.
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/PackagingUnitDetailSurchargeType'
          description: The type of surcharge, which is ABSOLUTE in this case.
      required:
        - tenantSurchargeType
        - type
        - amount
      title: PackagingUnitDetailAbsoluteSurcharge
      type: object
      description: PackagingUnitDetailAbsoluteSurcharge
    PackagingUnitDetailDimensions:
      properties:
        maxHeight:
          description: The max height of the packagingUnit in millimeters.
          type: number
        maxLength:
          description: The max length of the packagingUnit in millimeters.
          type: number
        maxWidth:
          description: The max width of the packagingUnit in millimeters.
          type: number
      required:
        - maxHeight
        - maxLength
        - maxWidth
      title: PackagingUnitDetailDimensions
      type: object
      description: PackagingUnitDetailDimensions
    PackagingUnitDetailForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleStringConstrained'
        carrierRef:
          description: The reference to the carrier associated with the packagingUnit.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        details:
          anyOf:
            - $ref: '#/components/schemas/PalletDetails'
            - $ref: '#/components/schemas/ParcelDetails'
            - $ref: '#/components/schemas/BulkyGoodsDetails'
            - $ref: '#/components/schemas/TwoManHandlingDetails'
        tenantPackagingUnitId:
          description: The tenant specific identifier for the packagingUnit.
          example: MY_PACKAGINGUNIT_ID
          type: string
      required:
        - nameLocalized
        - tenantPackagingUnitId
        - carrierRef
        - details
      title: PackagingUnitDetailForCreation
      type: object
      description: PackagingUnitDetailForCreation
    PackagingUnitDetailForUpdate:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleStringConstrained'
        carrierRef:
          description: The reference to the carrier associated with the packagingUnit.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        details:
          anyOf:
            - $ref: '#/components/schemas/PalletDetails'
            - $ref: '#/components/schemas/ParcelDetails'
            - $ref: '#/components/schemas/BulkyGoodsDetails'
            - $ref: '#/components/schemas/TwoManHandlingDetails'
        tenantPackagingUnitId:
          description: The tenant specific identifier for the packagingUnit.
          example: MY_PACKAGINGUNIT_ID
          type: string
        version:
          description: The version of the packagingUnit.
          example: 1
          type: number
      required:
        - nameLocalized
        - tenantPackagingUnitId
        - carrierRef
        - details
        - version
      title: PackagingUnitDetailForUpdate
      type: object
      description: PackagingUnitDetailForUpdate
    PackagingUnitDetailOverflowFactor:
      properties:
        factor:
          description: The factor appliable when the overflow factor is exceeded
          type: number
        price:
          $ref: '#/components/schemas/PackagingUnitsMoney'
      required:
        - price
        - factor
      title: PackagingUnitDetailOverflowFactor
      type: object
      description: PackagingUnitDetailOverflowFactor
    PackagingUnitDetailPricesByWeight:
      properties:
        price:
          $ref: '#/components/schemas/PackagingUnitsMoney'
        upperThreshold:
          description: The weight threshold in grams up to which this price applies.
          type: number
      required:
        - price
        - upperThreshold
      title: PackagingUnitDetailPricesByWeight
      type: object
      description: PackagingUnitDetailPricesByWeight
    PackagingUnitDetailPricingByZone:
      properties:
        overflowFactor:
          $ref: '#/components/schemas/PackagingUnitDetailOverflowFactor'
        prices:
          items:
            $ref: '#/components/schemas/PackagingUnitDetailPricesByWeight'
          maxItems: 500
          type: array
        zone:
          description: >-
            The shipping zone for which the pricing applies. Please proivide the
            ISO 3166-2 Country Code, followed by a dash and the first digits of
            the postal code, e.g. DE-50 for Cologne, Germany.
          type: string
      required:
        - prices
      title: PackagingUnitDetailPricingByZone
      type: object
      description: PackagingUnitDetailPricingByZone
    PackagingUnitDetailRelativeSurcharge:
      properties:
        percentage:
          description: The percentage of the surcharge.
          type: number
        tenantSurchargeType:
          description: The tenant specific identifier for the surcharge type.
          type: string
        type:
          allOf:
            - $ref: '#/components/schemas/PackagingUnitDetailSurchargeType'
          description: The type of surcharge, which is RELATIVE in this case.
      required:
        - tenantSurchargeType
        - type
        - percentage
      title: PackagingUnitDetailRelativeSurcharge
      type: object
      description: PackagingUnitDetailRelativeSurcharge
    PackagingUnitDetailSurchargeType:
      description: The type of surcharge, which is RELATIVE in this case.
      enum:
        - ABSOLUTE_SURCHARGE_TYPE
        - RELATIVE_SURCHARGE_TYPE
      title: PackagingUnitDetailSurchargeType
      type: string
    PackagingUnitDimensions:
      additionalProperties: false
      properties:
        height:
          description: The height of the packaging unit
          example: 50
          minimum: 0
          type: number
        length:
          description: The length of the packaging unit
          example: 100
          minimum: 0
          type: number
        maxWeightInGram:
          description: The weight of the packaging unit
          example: 1000
          minimum: 0
          type: number
        width:
          description: The width of the packaging unit
          example: 50
          minimum: 0
          type: number
      required:
        - length
        - width
        - height
        - maxWeightInGram
      type: object
      title: PackagingUnitDimensions
      description: PackagingUnitDimensions
    PackagingUnitsByContext:
      additionalProperties: false
      properties:
        context:
          items:
            $ref: '#/components/schemas/PackagingUnitContext'
          maxItems: 2000
          minItems: 0
          type: array
        packagingUnits:
          items:
            $ref: '#/components/schemas/PackagingUnit'
          maxItems: 2000
          minItems: 1
          type: array
      required:
        - context
        - packagingUnits
      type: object
      title: PackagingUnitsByContext
      description: PackagingUnitsByContext
    PackagingUnitsMoney:
      properties:
        currency:
          description: The ISO 4217 currency code, e.g. EUR for Euro.
          type: string
        decimalPlaces:
          default: 2
          description: The number of decimal places used by the currency, e.g. 2 for Euro.
          example: 2
          type: number
        value:
          description: The monetary value in the smallest currency unit
          type: number
      required:
        - currency
        - value
      title: PackagingUnitsMoney
      type: object
      description: PackagingUnitsMoney
    PackingConfigurations:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            documentHandlingConfiguration:
              $ref: '#/components/schemas/DocumentHandlingConfiguration'
            packingContainerRequiredConfiguration:
              $ref: '#/components/schemas/PackingContainerRequiredConfiguration'
            packingItemConfirmationNeededConfiguration:
              $ref: '#/components/schemas/PackingItemConfirmationNeededConfiguration'
            packingSourceContainerConfiguration:
              $ref: '#/components/schemas/PackingSourceContainerConfiguration'
            scanningConfiguration:
              $ref: '#/components/schemas/PackingScanningConfiguration'
      type: object
      title: PackingConfigurations
      description: PackingConfigurations
    PackingContainerRequiredConfiguration:
      additionalProperties: false
      description: Packing Container Required Configuration.
      properties:
        active:
          default: false
          type: boolean
      required:
        - active
      title: PackingContainerRequiredConfiguration
      type: object
    PackingContainerType:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            nameLocalized:
              $ref: '#/components/schemas/LocaleString'
            descriptionLocalized:
              $ref: '#/components/schemas/LocaleString'
            description:
              type: string
            dimensions:
              $ref: '#/components/schemas/ContainerDimensions'
            iconUrl:
              description: ''
              type: string
            id:
              description: ''
              type: string
            name:
              type: string
            priority:
              description: >-
                This value gives the priority of the respective
                packingContainerType. The lower the value the higher is the
                priority, e.g. priority 1 is higher than priority 10. The
                priority can be used to order packingContainerTypes in the UI.
              example: 100
              format: int32
              maximum: 10000
              minimum: 1
              type: integer
            weightLimitInG:
              description: 'Maximal weight in gramm(gr) the container can be loaded with. '
              example: 2500
              minimum: 1
              type: number
      required:
        - id
        - version
        - nameLocalized
      type: object
      title: PackingContainerType
      description: PackingContainerType
    PackingContainerTypeForCreation:
      additionalProperties: false
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        icon:
          $ref: '#/components/schemas/NamedFile'
        priority:
          description: >-
            This value gives the priority in the respective
            packingContainerType. The lower the value the higher is the
            priority, e.g. priority 1 is higher than priority 10. The priority
            can be used to order packingContainerTypes.
          example: 100
          format: int32
          maximum: 10000
          minimum: 1
          type: integer
        weightLimitInG:
          description: 'Maximal weight in gramm(gr) the container can be loaded with. '
          example: 2500
          minimum: 1
          type: number
      required:
        - nameLocalized
      type: object
      title: PackingContainerTypeForCreation
      description: PackingContainerTypeForCreation
    PackingContainerTypePatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyPackingContainerType'
              - $ref: '#/components/schemas/ModifyPackingContainerTypeIcon'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: PackingContainerTypePatchActions
      title: PackingContainerTypePatchActions
      description: PackingContainerTypePatchActions
    PackingItemConfirmationNeededConfiguration:
      additionalProperties: false
      description: Do the customer need to validate which items are part of a pack job
      properties:
        active:
          default: true
          type: boolean
      required:
        - active
      title: PackingItemConfirmationNeededConfiguration
      type: object
    PackingScanningConfiguration:
      description: Packing Scanning Configuration.
      properties:
        scanningType:
          $ref: '#/components/schemas/PackingScanningConfigurationEnum'
      title: PackingScanningConfiguration
      type: object
    PackingScanningConfigurationEnum:
      enum:
        - MUST_SCAN_EACH
        - SCAN_NOT_REQUIRED
      type: string
      title: PackingScanningConfigurationEnum
      description: PackingScanningConfigurationEnum
    PackingSourceContainer:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/BaseOperationalContainer'
        - properties:
            nameLocalized:
              $ref: '#/components/schemas/LocaleString'
            descriptionLocalized:
              $ref: '#/components/schemas/LocaleString'
            codes:
              items:
                description: Codes, that identify the container
                type: string
              minItems: 1
              type: array
            customAttributes:
              description: >-
                Attributes that can be added to the packing source container.
                These attributes cannot be used within fulfillment processes,
                but it could be useful to have the information carried here.
              type: object
            description:
              description: >-
                Description of the packing source container in the locale the
                client requests.
              type: string
            facilityRef:
              description: >-
                Reference to the facility the packing source container is
                related to.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            iconUrl:
              description: Url to the icon of the packing source container
              type: string
            id:
              description: >-
                The id of this packing source container. It is generated during
                creation automatically and suits as the primary identifier of
                the described entity.
              example: c7467ba8-c28a-4473-8748-a4e54e675e4c
              type: string
            lineItems:
              items:
                $ref: '#/components/schemas/PackingSourceContainerLineItem'
              type: array
            loadUnitRef:
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Deprecated: Use previousModuleContainerInfo instead. For
                load units ref see: type: LOAD_UNIT.
              example: 2357914c-d965-421e-b6cf-330501bccaab
              type: string
            name:
              description: >-
                Name of the packing source container in the locale the client
                requests.
              type: string
            operativeContainerTypeRef:
              description: Reference to the assigned operativeContainerType
              type: string
            packJobRefs:
              description: >-
                List of references to packJobs this packing source container is
                related to.
              items:
                example: 0857914c-d965-421e-b6cf-330501bcca58
                type: string
              minItems: 1
              type: array
            previousModuleContainerInfo:
              $ref: '#/components/schemas/PreviousModuleContainerInfo'
            storageLocationRef:
              description: >-
                Reference to the location where the packing source container is
                located.
              type: string
            type:
              $ref: '#/components/schemas/PackingSourceContainerType'
      required:
        - packJobRefs
        - nameLocalized
        - facilityRef
        - id
        - version
        - lastModified
        - created
        - lineItems
        - type
      type: object
      title: PackingSourceContainer
      description: PackingSourceContainer
    PackingSourceContainerConfiguration:
      description: Can this tenant use the packing source container
      properties:
        active:
          default: false
          type: boolean
      required:
        - active
      title: PackingSourceContainerConfiguration
      type: object
    PackingSourceContainerForCreation:
      allOf:
        - $ref: '#/components/schemas/BaseOperationalContainer'
        - properties:
            nameLocalized:
              $ref: '#/components/schemas/LocaleString'
            descriptionLocalized:
              $ref: '#/components/schemas/LocaleString'
            codes:
              items:
                description: Codes, that identify the article
                type: string
              minItems: 1
              type: array
            customAttributes:
              description: >-
                Attributes that can be added to the packing source container.
                These attributes cannot be used within fulfillment processes,
                but it could be useful to have the information carried here.
              type: object
            facilityRef:
              description: >-
                The id of the facility reference. The given ID has to be present
                in the system. But it is not updatable.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            icon:
              $ref: '#/components/schemas/NamedFile'
            lineItems:
              items:
                $ref: '#/components/schemas/PackingSourceContainerLineItemForCreation'
              type: array
            operativeContainerTypeRef:
              description: >-
                Reference to the operativeContainerType, available values will
                be taken from the container type while creating the container
              type: string
            packJobRefs:
              description: List of references to packJobs
              items:
                example: 0857914c-d965-421e-b6cf-330501bcca58
                type: string
              minItems: 1
              type: array
            previousModuleContainerInfo:
              $ref: '#/components/schemas/PreviousModuleContainerInfo'
            storageLocationRef:
              description: >-
                Reference to the location where the packing source container is
                located.
              type: string
      required:
        - packJobRefs
        - nameLocalized
        - facilityRef
        - lineItems
      type: object
      title: PackingSourceContainerForCreation
      description: PackingSourceContainerForCreation
    PackingSourceContainerLineItem:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - properties:
            article:
              $ref: '#/components/schemas/LineItemArticle'
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: da488ad1-4215-4b9a-9642-c39883c6cd2c
              type: string
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            quantity:
              description: quantity of this item
              example: 21
              format: int64
              minimum: 1
              type: integer
            secondaryMeasurementUnitKey:
              description: >-
                Identifier for items unit of measurement. E.g.
                measurementUnitKey is pieces and secondaryMeasurementUnitKey is
                gram
              example: gram
              type: string
            secondaryQuantity:
              description: >-
                secondary quantity of this item, E.g. quantity is the count and
                secondaryQuantity is the weight
              example: 200
              format: int64
              minimum: 1
              type: integer
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
      description: item that is inside the packingSourceContainer
      required:
        - id
        - quantity
        - article
      type: object
      xml:
        name: PackingSourceContainerLineItem
      title: PackingSourceContainerLineItem
    PackingSourceContainerLineItemForCreation:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItemForCreation'
        - properties:
            article:
              $ref: '#/components/schemas/LineItemArticle'
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            quantity:
              description: quantity of this item
              example: 21
              format: int64
              minimum: 1
              type: integer
            secondaryMeasurementUnitKey:
              description: >-
                Identifier for items unit of measurement. E.g.
                measurementUnitKey is pieces and secondaryMeasurementUnitKey is
                gram
              example: gram
              type: string
            secondaryQuantity:
              description: >-
                secondary quantity of this item, E.g. quantity is the count and
                secondaryQuantity is the weight
              example: 200
              format: int64
              minimum: 1
              type: integer
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
      description: items that are inside the packingSourceContainer
      required:
        - quantity
        - article
      type: object
      xml:
        name: PackingSourceContainerLineItemForCreation
      title: PackingSourceContainerLineItemForCreation
    PackingSourceContainerType:
      description: Type of the packing source container
      enum:
        - VIRTUAL
        - PHYSICAL
      type: string
      title: PackingSourceContainerType
    PackingSourceContainerWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/PackingSourceContainer'
      required:
        - payload
      type: object
      title: PackingSourceContainerWebHookEvent
      description: PackingSourceContainerWebHookEvent
    PackingTargetContainer:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/PackingTargetContainerForCreation'
        - $ref: '#/components/schemas/BaseOperationalContainer'
        - properties:
            nameLocalized:
              $ref: '#/components/schemas/LocaleString'
            descriptionLocalized:
              $ref: '#/components/schemas/LocaleString'
            description:
              description: >-
                Description of the packing source container in the locale the
                client requests. Automatically filled upon request.
              type: string
            dimensions:
              $ref: '#/components/schemas/ContainerDimensions'
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            facilityRef:
              description: >-
                The id of the facility reference. The given ID has to be present
                in the system. But it is not updatable via PUT request
              example: Esb20gpHBL94X5NdMp3C
              type: string
            iconUrl:
              description: >-
                Url to the icon of the packing source container  (inherited from
                operative container type).
              type: string
            id:
              description: >-
                The id of this packing source container. It is generated during
                creation automatically and suits as the primary identifier of
                the described entity.
              type: string
            lineItems:
              items:
                $ref: '#/components/schemas/PackingTargetContainerLineItem'
              type: array
            name:
              description: >-
                Name of the packing source container in the locale the client
                requests. Automatically filled upon request.
              type: string
            operativeProcessRef:
              description: >-
                Reference to the operative process this packing target container
                is related to.
              type: string
            packJobRef:
              description: >-
                Reference to the packJob this packing source container is
                related to.
              type: string
            parcels:
              items:
                $ref: '#/components/schemas/Parcel'
              type: array
            shortId:
              description: Short identifier for the container
              type: string
            type:
              $ref: '#/components/schemas/PackingTargetContainerType'
            weightLimitInG:
              description: 'Maximal weight in gramm(gr) the container can be loaded with. '
              example: 2500
              minimum: 1
              type: number
      required:
        - id
        - nameLocalized
        - version
        - facilityRef
        - packJobRef
        - lineItems
        - type
      type: object
      title: PackingTargetContainer
      description: PackingTargetContainer
    PackingTargetContainerActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/UpdatePackingTargetContainerLineItemAction'
        - $ref: >-
            #/components/schemas/ReplacePackingTargetContainerLineItemCodesAction
      title: PackingTargetContainerActionsParameter
      description: PackingTargetContainerActionsParameter
    PackingTargetContainerAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      title: PackingTargetContainerAttributeItem
      description: PackingTargetContainerAttributeItem
    PackingTargetContainerForCreation:
      allOf:
        - $ref: '#/components/schemas/BaseOperationalContainer'
        - properties:
            codes:
              items:
                description: List of codes
                minItems: 1
                type: string
              type: array
            lineItems:
              items:
                $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation'
              type: array
            operativeContainerTypeRef:
              type: string
            packingContainerTypeRef:
              description: deprecated - use operativeContainerTypeRef instead
              type: string
            storageLocationRef:
              description: >-
                Reference to the location where the packing target container is
                located.
              type: string
      required:
        - codes
      type: object
      title: PackingTargetContainerForCreation
      description: PackingTargetContainerForCreation
    PackingTargetContainerLineItem:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - properties:
            article:
              $ref: '#/components/schemas/PackingTargetContainerLineItemArticle'
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            quantity:
              description: quantity of the item
              example: 21
              format: int64
              minimum: 1
              type: integer
            secondaryMeasurementUnitKey:
              description: >-
                Identifier for items unit of measurement. E.g.
                measurementUnitKey is pieces and secondaryMeasurementUnitKey is
                gram
              example: gram
              type: string
            secondaryQuantity:
              description: >-
                secondary quantity of this item, E.g. quantity is the count and
                secondaryQuantity is the weight
              example: 200
              format: int64
              minimum: 1
              type: integer
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
      required:
        - id
        - article
        - quantity
      type: object
      title: PackingTargetContainerLineItem
      description: PackingTargetContainerLineItem
    PackingTargetContainerLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/PackingTargetContainerAttributeItem'
              maxItems: 40
              type: array
          type: object
      xml:
        name: PackingTargetContainerLineItemArticle
      title: PackingTargetContainerLineItemArticle
      description: PackingTargetContainerLineItemArticle
    PackingTargetContainerLineItemForCreation:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItemForCreation'
        - properties:
            article:
              $ref: '#/components/schemas/PackingTargetContainerLineItemArticle'
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            quantity:
              description: quantity of the item
              example: 21
              format: int64
              minimum: 1
              type: integer
            secondaryMeasurementUnitKey:
              description: >-
                Identifier for items unit of measurement. E.g.
                measurementUnitKey is pieces and secondaryMeasurementUnitKey is
                gram
              example: gram
              type: string
            secondaryQuantity:
              description: >-
                secondary quantity of this item, E.g. quantity is the count and
                secondaryQuantity is the weight
              example: 200
              format: int64
              minimum: 1
              type: integer
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
      required:
        - article
        - quantity
      type: object
      title: PackingTargetContainerLineItemForCreation
      description: PackingTargetContainerLineItemForCreation
    PackingTargetContainerPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ReplaceCodesInPackingTargetContainer'
              - $ref: '#/components/schemas/AddLineItemToPackingTargetContainer'
              - $ref: '#/components/schemas/RemoveLineItemFromPackingTargetContainer'
              - $ref: '#/components/schemas/UpdateLineItemOnPackingTargetContainer'
              - $ref: >-
                  #/components/schemas/UpdatePackingTargetContainerLineItemRecordableAttributes
              - $ref: >-
                  #/components/schemas/UpdatePackingTargetContainerStorageLocation
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: PackingTargetContainerPatchActions
      title: PackingTargetContainerPatchActions
      description: PackingTargetContainerPatchActions
    PackingTargetContainerType:
      description: Type of the packing taret container
      enum:
        - VIRTUAL
        - PHYSICAL
      type: string
      title: PackingTargetContainerType
    PackingTargetContainerWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/PackingTargetContainer'
      required:
        - payload
      type: object
      title: PackingTargetContainerWebHookEvent
      description: PackingTargetContainerWebHookEvent
    PackJob:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            assignedUsers:
              description: Assigned users for this entity
              items:
                $ref: '#/components/schemas/AssignedUser'
              type: array
            customAttributes:
              description: >-
                Attributes that can be added to the pack job. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the informations carried here.
              type: object
            deliveryChannel:
              enum:
                - COLLECT
                - SHIPPING
              type: string
            documentHandling:
              $ref: '#/components/schemas/DocumentHandling'
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            editor:
              $ref: '#/components/schemas/Editor'
            facilityRef:
              description: >-
                Reference to the facility you want to get the corresponding
                packjob
              example: Esb50gpH7794X5NdMp3C
              type: string
            id:
              description: >-
                The id of this pack job. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            invoice:
              $ref: '#/components/schemas/ConsumerAddress'
            lineItems:
              items:
                $ref: '#/components/schemas/PackLineItem'
              type: array
            operativeProcessRef:
              type: string
            orderDate:
              description: Date when the order was placed.
              example: 2020-02-03T09:45:51.525Z
              format: date-time
              type: string
            orderRef:
              description: The id of the order
              type: string
            packingSourceContainers:
              items:
                $ref: '#/components/schemas/StrippedPackingSourceContainer'
            pickJobRef:
              description: Reference to a pick job
              example: Pic50gpH7794X5NdMp3C
              type: string
            processId:
              description: >-
                Id of the global process related to this entity. For example
                used for starting the GDPR process and others.
              type: string
            recipient:
              $ref: '#/components/schemas/ConsumerAddress'
            recipientName:
              description: The name of the recipient
              type: string
            shortId:
              description: The short identifier of the shipment.
              type: string
            status:
              $ref: '#/components/schemas/PackJobStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            targetTime:
              description: Until when the pack job must be finished.
              example: 2020-02-03T09:45:51.525Z
              format: date-time
              type: string
            tenantOrderId:
              type: string
            transfers:
              items:
                $ref: '#/components/schemas/OperativeTransfer'
              minItems: 0
              type: array
            workflowInformation:
              oneOf:
                - $ref: '#/components/schemas/WorkflowInformation'
                - $ref: '#/components/schemas/WorkflowUnavailable'
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              minItems: 1
              type: array
          required:
            - id
            - facilityRef
            - documentsRef
            - status
            - lineItems
            - processId
            - workflowInformation
          type: object
          xml:
            name: PackJob
      title: PackJob
      description: PackJob
    PackJobActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/PackJobReplaceAssignedUsersActionParameter'
        - $ref: '#/components/schemas/PackJobSplitLineItemsActionParameter'
        - $ref: >-
            #/components/schemas/UpdatePackLineItemRecordableAttributesActionParameter
        - $ref: >-
            #/components/schemas/PackJobMoveEachesToSourceContainerActionParameter
        - $ref: >-
            #/components/schemas/PackJobMoveEachesToTargetContainerActionParameter
        - $ref: '#/components/schemas/PackJobAddTargetTimeActionParameter'
      title: PackJobActionsParameter
      description: PackJobActionsParameter
    PackJobAddTargetTimeActionEnum:
      enum:
        - ADD_TARGET_TIME
      type: string
      title: PackJobAddTargetTimeActionEnum
      description: PackJobAddTargetTimeActionEnum
    PackJobAddTargetTimeActionParameter:
      additionalProperties: false
      description: >-
        Action to add targetTime to a PackJob that has none. Will fail if
        targetTime is already set
      properties:
        name:
          $ref: '#/components/schemas/PackJobAddTargetTimeActionEnum'
        targetTime:
          description: The target time you want set for the given packJob.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - targetTime
      title: PackJobAddTargetTimeActionParameter
    PackJobCreationPerTag:
      properties:
        matchingValues:
          items:
            minItems: 1
            type: string
          type: array
        packJobCreationDisabled:
          type: boolean
        tagRef:
          type: string
      required:
        - packJobCreationDisabled
        - matchingValues
        - tagRef
      type: object
      title: PackJobCreationPerTag
      description: PackJobCreationPerTag
    PackJobForCreation:
      additionalProperties: false
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the pack job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        deliveryChannel:
          enum:
            - COLLECT
            - SHIPPING
          type: string
        facilityRef:
          description: Reference to the facility you want to get the corresponding packjob
          example: Esb50gpH7794X5NdMp3C
          type: string
        invoice:
          $ref: '#/components/schemas/ConsumerAddress'
        lineItems:
          items:
            $ref: '#/components/schemas/PackLineItemForCreation'
          type: array
        operativeProcessRef:
          type: string
        orderDate:
          description: Date when the order was placed.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        orderRef:
          description: The id of the order
          type: string
        pickJobRef:
          description: Reference to a pick job
          example: Pic50gpH7794X5NdMp3C
          type: string
        processId:
          description: >-
            Id of the global process related to this entity. For example used
            for starting the GDPR process and others.
          type: string
        recipient:
          $ref: '#/components/schemas/ConsumerAddress'
        recipientName:
          description: The name of the recipient
          type: string
        shortId:
          description: The short identifier of the shipment.
          type: string
        status:
          $ref: '#/components/schemas/PackJobStatus'
        targetTime:
          description: Until when the pack job must be finished.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        tenantOrderId:
          type: string
        transfers:
          items:
            $ref: '#/components/schemas/OperativeTransfer'
          minItems: 0
          type: array
        workflowInformation:
          oneOf:
            - $ref: '#/components/schemas/WorkflowInformation'
            - $ref: '#/components/schemas/WorkflowUnavailable'
        tags:
          description: >-
            Tags can only be set when there is no process related with this
            packJob. Setting processId and tags will lead to an validationError.
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - facilityRef
        - lineItems
        - workflowInformation
      type: object
      xml:
        name: PackJobForCreation
      title: PackJobForCreation
      description: PackJobForCreation
    PackJobInvoiceFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: PackJobInvoiceFilter
      type: object
      description: PackJobInvoiceFilter
    PackJobLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by title
      title: PackJobLineItemsArticleFilter
      type: object
      description: PackJobLineItemsArticleFilter
    PackJobLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/PackJobLineItemsArticleFilter'
          description: Nested search by article
      title: PackJobLineItemsFilter
      type: object
      description: PackJobLineItemsFilter
    PackJobLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/PackJobLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: PackJobLineItemsListFilter
      type: object
      description: PackJobLineItemsListFilter
    PackJobMoveEachesToContainerActionParameterMove:
      additionalProperties: false
      description: Assigned users for this entity
      properties:
        from:
          items:
            $ref: '#/components/schemas/PackJobMoveEachesToContainerFrom'
          minItems: 1
          type: array
        to:
          oneOf:
            - $ref: '#/components/schemas/PackJobMoveEachesToContainerTo'
            - $ref: '#/components/schemas/PackJobMoveEachesToNewContainerTo'
      required:
        - from
        - to
      type: object
      title: PackJobMoveEachesToContainerActionParameterMove
    PackJobMoveEachesToContainerFrom:
      additionalProperties: false
      description: Where to take the eaches from
      properties:
        containerId:
          description: id of the container to move the eaches from
          type: string
        containerVersion:
          description: version of the container to move the eaches from
          minimum: 0
          type: integer
        globalLineItemId:
          description: global line item id of the line item to move eaches from
          type: string
        quantity:
          description: amount of items to move
          minimum: 0
          type: integer
        secondaryQuantity:
          description: secondary amount of items to move
          minimum: 0
          type: integer
      required:
        - containerId
        - containerVersion
        - globalLineItemId
        - quantity
      title: PackJobMoveEachesToContainerFrom
      type: object
    PackJobMoveEachesToContainerTo:
      additionalProperties: false
      description: Where to move the eaches to.
      properties:
        containerId:
          description: id of the container to move the eaches to
          type: string
        containerVersion:
          description: version of the container to move the eaches to
          minimum: 0
          type: integer
      required:
        - containerId
        - containerVersion
      title: PackJobMoveEachesToContainerTo
      type: object
    PackJobMoveEachesToNewContainerTo:
      additionalProperties: false
      description: Additional information for the new created container during a move
      properties:
        codes:
          items:
            description: Codes, that identify the container
            type: string
          type: array
        operativeContainerTypeRef:
          description: the reference to the operativeContainerType
          type: string
      required:
        - operativeContainerTypeRef
      title: PackJobMoveEachesToContainerTo
      type: object
    PackJobMoveEachesToSourceContainerActionEnum:
      enum:
        - MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER
      type: string
      title: PackJobMoveEachesToSourceContainerActionEnum
      description: PackJobMoveEachesToSourceContainerActionEnum
    PackJobMoveEachesToSourceContainerActionParameter:
      additionalProperties: false
      description: Action to replace the assigned users.
      properties:
        move:
          $ref: '#/components/schemas/PackJobMoveEachesToContainerActionParameterMove'
        name:
          $ref: '#/components/schemas/PackJobMoveEachesToSourceContainerActionEnum'
      required:
        - name
        - move
      title: PackJobReplaceAssignedUsersActionParameter
      type: object
    PackJobMoveEachesToTargetContainerActionEnum:
      enum:
        - MOVE_EACHES_TO_PACKING_TARGET_CONTAINER
      type: string
      title: PackJobMoveEachesToTargetContainerActionEnum
      description: PackJobMoveEachesToTargetContainerActionEnum
    PackJobMoveEachesToTargetContainerActionParameter:
      additionalProperties: false
      description: Action to replace the assigned users.
      properties:
        move:
          $ref: '#/components/schemas/PackJobMoveEachesToContainerActionParameterMove'
        name:
          $ref: '#/components/schemas/PackJobMoveEachesToTargetContainerActionEnum'
      required:
        - name
        - move
      title: PackJobReplaceAssignedUsersActionParameter
      type: object
    PackJobOrderBy:
      description: Attribute to order a packJobs by
      enum:
        - TARGET_TIME_DESC
        - TARGET_TIME_ASC
        - LAST_MODIFIED_DESC
        - LAST_MODIFIED_ASC
        - ORDER_DATE_DESC
        - ORDER_DATE_ASC
      type: string
      xml:
        name: PackJobOrderBy
      title: PackJobOrderBy
    PackJobPackingSourceContainersFilter:
      properties:
        codes:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by codes
      title: PackJobPackingSourceContainersFilter
      type: object
      description: PackJobPackingSourceContainersFilter
    PackJobPackingSourceContainersListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/PackJobPackingSourceContainersFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: PackJobPackingSourceContainersListFilter
      type: object
      description: PackJobPackingSourceContainersListFilter
    PackJobPaginatedResult:
      properties:
        packJobs:
          items:
            $ref: '#/components/schemas/PackJob'
          type: array
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - packJobs
      title: PackJobPaginatedResult
      type: object
      description: PackJobPaginatedResult
    PackJobPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyPackJob'
              - $ref: '#/components/schemas/ModifyPackLineItem'
              - $ref: '#/components/schemas/PausePackJob'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: PackJobPatchActions
      title: PackJobPatchActions
      description: PackJobPatchActions
    PackJobRecipientFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: PackJobRecipientFilter
      type: object
      description: PackJobRecipientFilter
    PackJobReplaceAssignedUsersActionEnum:
      enum:
        - REPLACE_ASSIGNED_USERS
      type: string
      title: PackJobReplaceAssignedUsersActionEnum
      description: PackJobReplaceAssignedUsersActionEnum
    PackJobReplaceAssignedUsersActionParameter:
      additionalProperties: false
      description: Action to replace the assigned users.
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          type: array
        name:
          $ref: '#/components/schemas/PackJobReplaceAssignedUsersActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - assignedUsers
      title: PackJobReplaceAssignedUsersActionParameter
      type: object
    PackJobs:
      properties:
        packJobs:
          items:
            $ref: '#/components/schemas/PackJobWithSearchPath'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: PackJobs
      description: PackJobs
    PackJobSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/PackJobSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/PackJobSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: PackJobSearchPayload
      type: object
      description: PackJobSearchPayload
    PackJobSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/PackJobSearchQuery'
          maxItems: 500
          type: array
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringEqFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        invoice:
          allOf:
            - $ref: '#/components/schemas/PackJobInvoiceFilter'
          description: Nested search by invoice
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        lineItems:
          allOf:
            - $ref: '#/components/schemas/PackJobLineItemsListFilter'
          description: Nested list search by lineItems
        or:
          items:
            $ref: '#/components/schemas/PackJobSearchQuery'
          maxItems: 500
          type: array
        orderDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by orderDate. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
          example: 2026-06-17T12:00:00.000Z
        packingSourceContainers:
          allOf:
            - $ref: '#/components/schemas/PackJobPackingSourceContainersListFilter'
          description: Nested list search by packingSourceContainers
        recipient:
          allOf:
            - $ref: '#/components/schemas/PackJobRecipientFilter'
          description: Nested search by recipient
        shortId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by shortId
        status:
          allOf:
            - $ref: '#/components/schemas/PackJobStatusEnumFilter'
          description: Search by status
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: PackJobSearchQuery
      type: object
      description: PackJobSearchQuery
    PackJobSort:
      properties:
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        orderDate:
          enum:
            - ASC
            - DESC
          type: string
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
      title: PackJobSort
      type: object
      description: PackJobSort
    PackJobSplitLineItemsActionEnum:
      enum:
        - SPLIT_LINES_PACK_JOB
      type: string
      title: PackJobSplitLineItemsActionEnum
      description: PackJobSplitLineItemsActionEnum
    PackJobSplitLineItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PackJobSplitLineItemsActionEnum'
        splitLineItemsInfo:
          items:
            $ref: '#/components/schemas/PackJobSplitLineItemsInfo'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - splitLineItemsInfo
      title: PackJobSplitLineItemsActionParameter
      type: object
      description: PackJobSplitLineItemsActionParameter
    PackJobSplitLineItemsInfo:
      additionalProperties: false
      properties:
        lineItemId:
          description: references the id of the packLineItem of a packJob
          type: string
        packed:
          description: The amount of articles that were packed for this line item.
          example: 20
          format: int64
          minimum: 0
          type: integer
        quantity:
          description: quantity of the specific item that has been ordered
          example: 21
          minimum: 1
          type: integer
      required:
        - lineItemId
        - quantity
      type: object
      title: PackJobSplitLineItemsInfo
      description: PackJobSplitLineItemsInfo
    PackJobStatus:
      description: >-
        A pack job initially has the status OPEN and packing can start. When
        packing has started, the pack job changes its status to IN_PROGRESS.
        After a pack job has been completely packed its status becomes CLOSED.
      enum:
        - OPEN
        - IN_PROGRESS
        - CLOSED
        - OBSOLETE
        - CANCELED
        - PAUSED
      type: string
      xml:
        name: PackJobStatus
      title: PackJobStatus
    PackJobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - OBSOLETE
            - CANCELED
            - PAUSED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - IN_PROGRESS
              - CLOSED
              - OBSOLETE
              - CANCELED
              - PAUSED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - OBSOLETE
            - CANCELED
            - PAUSED
          type: string
      title: PackJobStatusEnumFilter
      type: object
      description: PackJobStatusEnumFilter
    PackJobTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/TagConfiguration'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            lineItemStickerConfiguration:
              $ref: '#/components/schemas/StickerConfiguration'
            packJobCreationPerTag:
              description: >-
                All entries with a match in their matchingValues will be
                combined when determining what documents belong to an entity
              items:
                $ref: '#/components/schemas/PackJobCreationPerTag'
              type: array
            stickerConfiguration:
              $ref: '#/components/schemas/StickerConfiguration'
      required:
        - packJobCreationPerTag
        - version
      type: object
      title: PackJobTagConfiguration
      description: PackJobTagConfiguration
    PackJobWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/PackJob'
      required:
        - payload
      type: object
      title: PackJobWebHookEvent
      description: PackJobWebHookEvent
    PackJobWithSearchPath:
      allOf:
        - $ref: '#/components/schemas/PackJob'
        - additionalProperties: false
          properties:
            searchPaths:
              items:
                type: string
              minItems: 0
              type: array
      xml:
        name: PackJobWithPath
      title: PackJobWithSearchPath
      description: PackJobWithSearchPath
    PackLineItem:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - properties:
            article:
              $ref: '#/components/schemas/PackLineItemArticle'
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            packed:
              description: The amount of articles that were packed for this packline.
              example: 20
              format: int32
              minimum: 0
              type: integer
            quantity:
              description: quantity of this item
              example: 21
              format: int64
              minimum: 1
              type: integer
            serviceJobRefs:
              description: Reference to the service job that has altered this line item
              items:
                type: string
              type: array
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
          required:
            - id
            - quantity
            - article
      type: object
      xml:
        name: PackLineItem
      title: PackLineItem
      description: PackLineItem
    PackLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              maxItems: 40
              type: array
      type: object
      xml:
        name: PackLineItemArticle
      title: PackLineItemArticle
      description: PackLineItemArticle
    PackLineItemForCreation:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItemForCreation'
        - properties:
            article:
              $ref: '#/components/schemas/PackLineItemArticle'
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            quantity:
              description: quantity of this item
              example: 21
              format: int64
              minimum: 1
              type: integer
            serviceJobRefs:
              description: Reference to the service job that has altered this line item
              items:
                type: string
              type: array
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
          required:
            - quantity
            - article
      type: object
      xml:
        name: PackLineItemForCreation
      title: PackLineItemForCreation
      description: PackLineItemForCreation
    PackLineItemForUpdate:
      properties:
        id:
          description: references the id of the packLineItem of a packJob
          type: string
        packed:
          description: >-
            The amount of articles that were packed for this packline. Can't be
            more than picked before.
          example: 20
          format: int64
          minimum: 0
          type: integer
      required:
        - id
        - packed
      type: object
      xml:
        name: PackLineItemForUpdate
      title: PackLineItemForUpdate
      description: PackLineItemForUpdate
    PageInfo:
      properties:
        endCursor:
          description: >-
            The cursor to use to fetch the next page of items. Use with
            parameter `after`.
          type: string
        hasNextPage:
          description: If true, there are more items after the current page.
          type: boolean
        hasPreviousPage:
          description: If true, there are more items before the current page.
          type: boolean
        startCursor:
          description: The cursor to use to fetch the previous page of items.
          type: string
      required:
        - hasNextPage
        - hasPreviousPage
        - startCursor
        - endCursor
      title: PageInfo
      type: object
      description: PageInfo
    PaginatedPackingSourceContainers:
      properties:
        packingSourceContainers:
          items:
            $ref: '#/components/schemas/PackingSourceContainer'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: PaginatedPackingSourceContainers
      description: PaginatedPackingSourceContainers
    PalletDetails:
      properties:
        dimensions:
          $ref: '#/components/schemas/PackagingUnitDetailDimensions'
        maxItemQuantity:
          description: The maximum number of items that can fit in the packagingUnit.
          type: number
        maxWeight:
          description: The maximum weight in grams that the packagingUnit can hold.
          type: number
        packagingPricingDetails:
          $ref: '#/components/schemas/PackagingPricingDetails'
        type:
          description: The type of the packagingUnit.
          enum:
            - PALLET
            - TWO_MAN_HANDLING
            - PARCEL
            - BULKY_GOODS
          type: string
        volumeBufferInPercent:
          description: The volume buffer in percent for the packagingUnit.
          type: number
        volumetricWeightFactor:
          description: The volumetric weight factor for the packagingUnit.
          type: number
      required:
        - type
        - dimensions
        - maxWeight
        - volumetricWeightFactor
        - packagingPricingDetails
      title: PalletDetails
      type: object
      description: PalletDetails
    Parcel:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/BaseOperationalContainer'
        - properties:
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            carrierInformation:
              $ref: '#/components/schemas/ParcelCarrierInformation'
            carrierProduct:
              description: Desired product of given carrier to choose when ordering a label
              example: EXPRESS
              type: string
            carrierRef:
              description: Reference to the carrier this parcel should be send by
              example: cf00e102-34f2-45c1-a846-6a21f384321e
              type: string
            customAttributes:
              description: >-
                Attributes that can be added to the parcel. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the information carried here.
              type: object
            customProductValue:
              description: >-
                Set this value if you want to overwrite the calculated product
                value of the parcel. This field uses the smallest denomination,
                e.g. Euro Cents. So a value of 1250 represents 12,50€.
              example: 12.5
              type: number
            dimensions:
              $ref: '#/components/schemas/ParcelDimensions'
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            facilityRef:
              type: string
            id:
              description: >-
                The id of this parcel. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: 95EWrieX09OmeriXIUbb
              type: string
            invoice:
              $ref: '#/components/schemas/ConsumerAddress'
            items:
              items:
                $ref: '#/components/schemas/ParcelItem'
              type: array
            loadUnitRefs:
              description: Reference to array of load unit Refs
              items:
                type: string
              type: array
            operativeProcessRef:
              type: string
            paymentInformation:
              $ref: '#/components/schemas/PaymentInformation'
            pickUpInformation:
              $ref: '#/components/schemas/ParcelPickUpInformation'
            postalCharges:
              $ref: '#/components/schemas/ParcelPostalCharge'
            processRef:
              type: string
            productValue:
              description: >-
                Monetary value of all goods in this parcel. Needed for sending
                cross border packages (customs) To be interpreted as money in
                the currency given under paymentInformation.currency. This field
                uses the smallest denomination, e.g. Euro Cents. So a value of
                1250 represents 12,50€.
              example: 1250
              type: number
            productValueCurrency:
              $ref: '#/components/schemas/ProductValueCurrency'
            productValueType:
              $ref: '#/components/schemas/ProductValueType'
            recipient:
              $ref: '#/components/schemas/ConsumerAddress'
            result:
              $ref: '#/components/schemas/ParcelResult'
            returnAddress:
              $ref: '#/components/schemas/FacilityAddress'
            sender:
              $ref: '#/components/schemas/FacilityAddress'
            services:
              $ref: '#/components/schemas/ParcelServices'
            shipmentRef:
              description: The id of this shipment this parcel has been created for.
              example: 95EWrieX09OmeriXIUbb
              type: string
            shortId:
              example: AA12-1
              type: string
            status:
              $ref: '#/components/schemas/ParcelStatus'
            tenantOrderId:
              description: >-
                Field can be used as a reference number in foreign systems, for
                example as a reference to the source system's identifier for
                this order.
              example: R456728546
              type: string
            tenantParcelId:
              description: >-
                Tenant specific parcel id, needs to be unique for non obsolete
                or canceled parcel
              example: MY-PARCEL-12345
              type: string
            transfers:
              items:
                $ref: '#/components/schemas/OperativeTransfer'
              minItems: 0
              type: array
            workflowInformation:
              oneOf:
                - $ref: '#/components/schemas/WorkflowInformation'
                - $ref: '#/components/schemas/WorkflowUnavailable'
          required:
            - id
            - status
            - carrierRef
            - processRef
            - sender
            - recipient
            - loadUnitRefs
            - workflowInformation
          type: object
      type: object
      title: Parcel
      description: Parcel
    ParcelActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/ParcelSplitItemsActionParameter'
        - $ref: '#/components/schemas/ParcelUpdateTrackingDataActionParameter'
        - $ref: >-
            #/components/schemas/UpdateParcelItemRecordableAttributesActionParameter
        - $ref: '#/components/schemas/AddLabelsToParcelActionParameter'
      title: ParcelActionsParameter
      description: ParcelActionsParameter
    ParcelArticleAttributeItemForUpdate:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      required:
        - key
        - value
        - category
      title: ParcelArticleAttributeItemForUpdate
      description: ParcelArticleAttributeItemForUpdate
    ParcelCarrierInformation:
      additionalProperties: false
      description: Carrier specific information about the parcel for the label creation
      properties:
        shippingContainerNumber:
          description: Specific shipping container number for the parcel
          example: 123456-ABC
          type: string
      type: object
      title: ParcelCarrierInformation
    ParcelDetails:
      properties:
        dimensions:
          $ref: '#/components/schemas/PackagingUnitDetailDimensions'
        maxItemQuantity:
          description: The maximum number of items that can fit in the packagingUnit.
          type: number
        maxWeight:
          description: The maximum weight in grams that the packagingUnit can hold.
          type: number
        packagingPricingDetails:
          $ref: '#/components/schemas/PackagingPricingDetails'
        type:
          description: The type of the packagingUnit.
          enum:
            - PALLET
            - TWO_MAN_HANDLING
            - PARCEL
            - BULKY_GOODS
          type: string
        volumeBufferInPercent:
          description: The volume buffer in percent for the packagingUnit.
          type: number
      required:
        - type
        - dimensions
        - maxWeight
        - packagingPricingDetails
      title: ParcelDetails
      type: object
      description: ParcelDetails
    ParcelDimensions:
      additionalProperties: false
      nullable: true
      properties:
        customWeight:
          type: number
        height:
          type: number
        length:
          type: number
        weight:
          type: number
        width:
          type: number
      type: object
      title: ParcelDimensions
      description: ParcelDimensions
    ParcelForCreation:
      additionalProperties: false
      properties:
        carrierInformation:
          $ref: '#/components/schemas/ParcelCarrierInformation'
        carrierProduct:
          description: Desired product of given carrier to choose when ordering a label
          example: EXPRESS
          type: string
        carrierRef:
          description: >-
            references the carrier to be used for sending. Can not be set when
            creating a parcel for an existing shipment.
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the parcel. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the information carried here.
          type: object
        customProductValue:
          description: >-
            Set this value if you want to overwrite the calculated product value
            of the parcel.
          example: 12.5
          type: number
        dimensions:
          $ref: '#/components/schemas/ParcelDimensions'
        invoice:
          $ref: '#/components/schemas/ConsumerAddress'
        items:
          items:
            $ref: '#/components/schemas/ParcelItemForCreation'
          type: array
        loadUnitRefs:
          description: Reference to array of load unit Refs
          items:
            type: string
          type: array
        parentRef:
          description: Reference to the parent container of this parcel
          type: string
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        pickUpInformation:
          $ref: '#/components/schemas/ParcelPickUpInformation'
        productValue:
          description: >-
            Monetary value of all goods in this parcel. Needed for sending cross
            border packages (customs) To be interpreted as money in the currency
            given under paymentInformation.currency. This value is calculated
            from the items in the parcel.
          example: 12.5
          type: number
        productValueCurrency:
          $ref: '#/components/schemas/ProductValueCurrency'
        productValueType:
          $ref: '#/components/schemas/ProductValueType'
        recipient:
          $ref: '#/components/schemas/ConsumerAddress'
        result:
          $ref: '#/components/schemas/ParcelResult'
        returnAddress:
          $ref: '#/components/schemas/FacilityAddress'
        sender:
          $ref: '#/components/schemas/FacilityAddress'
        services:
          $ref: '#/components/schemas/ParcelServices'
        shortId:
          example: AA12-1
          type: string
        status:
          $ref: '#/components/schemas/ParcelStatus'
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        tenantParcelId:
          description: >-
            Tenant specific parcel id, needs to be unique for non obsolete or
            canceled parcel
          example: MY-PARCEL-12345
          type: string
        transfers:
          items:
            $ref: '#/components/schemas/OperativeTransfer'
          minItems: 0
          type: array
      type: object
      title: ParcelForCreation
      description: ParcelForCreation
    ParcelForDirectCreation:
      additionalProperties: false
      properties:
        carrierProduct:
          description: Desired product of given carrier to choose when ordering a label
          example: EXPRESS
          type: string
        carrierRef:
          description: >-
            references the carrier to be used for sending. Can not be set when
            creating a parcel for an existing shipment.
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the parcel. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the information carried here.
          type: object
        customProductValue:
          description: >-
            Set this value if you want to overwrite the calculated product value
            of the parcel.
          example: 12.5
          type: number
        dimensions:
          $ref: '#/components/schemas/ParcelDimensions'
        facilityRef:
          description: Reference to the facility this parcel is created for
          example: 95EWrieX09OmeriXIUbb
          type: string
        invoice:
          $ref: '#/components/schemas/ConsumerAddress'
        items:
          items:
            $ref: '#/components/schemas/ParcelItemForCreation'
          type: array
        loadUnitRefs:
          description: Reference to array of load unit Refs
          items:
            type: string
          type: array
        operativeProcessRef:
          description: Reference to the operative process this parcel is created for
          example: 95EWrieX09OmeriXIUbb
          type: string
        orderDate:
          description: >-
            Date when the order for the given parcel has been placed Mandatory
            when no shipmentRef was provided
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        pickUpInformation:
          $ref: '#/components/schemas/ParcelPickUpInformation'
        processRef:
          description: Reference to the process this parcel is created for
          example: 95EWrieX09OmeriXIUbb
          type: string
        productValue:
          description: >-
            Monetary value of all goods in this parcel. Needed for sending cross
            border packages (customs) To be interpreted as money in the currency
            given under paymentInformation.currency. This value is calculated
            from the items in the parcel.
          example: 12.5
          type: number
        productValueCurrency:
          $ref: '#/components/schemas/ProductValueCurrency'
        productValueType:
          $ref: '#/components/schemas/ProductValueType'
        recipient:
          $ref: '#/components/schemas/ConsumerAddress'
        result:
          $ref: '#/components/schemas/ParcelResult'
        returnAddress:
          $ref: '#/components/schemas/FacilityAddress'
        sender:
          $ref: '#/components/schemas/FacilityAddress'
        services:
          $ref: '#/components/schemas/ParcelServices'
        shipmentRef:
          description: >-
            Reference to the shipment this parcel is created for. If non
            provided, a shipment will be created automatically.
          example: 95EWrieX09OmeriXIUbb
          type: string
        shortId:
          example: AA12-1
          type: string
        status:
          $ref: '#/components/schemas/ParcelStatus'
        targetTime:
          description: >-
            The target time for the parcel to be delivered. If not provided, the
            current time will be used.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        tenantParcelId:
          description: >-
            Tenant specific parcel id, needs to be unique for non obsolete or
            canceled parcel
          example: MY-PARCEL-12345
          type: string
      required:
        - facilityRef
        - carrierRef
        - recipient
        - sender
      type: object
      title: ParcelForDirectCreation
      description: ParcelForDirectCreation
    ParcelInformation:
      properties:
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        created:
          description: Creation date of this parcelInformation
          example: 2026-04-15T08:02:01.956Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        dimensions:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationDimensions'
          description: Dimension information of this parcel information
        facilityRef:
          description: Reference to related facility
          example: 019eefb2-0001-7000-9000-100000000002
          type: string
        id:
          description: Unique identifier of this parcelInformation
          example: 019eefb1-4bd1-7ef0-98ba-f91e07243ea7
          type: string
        lastModified:
          description: Last modification date of this parcelInformation
          example: 2026-04-15T08:02:01.956Z
          format: date-time
          type: string
        operativeProcessRef:
          description: Reference to related operative process.
          example: 019eefb2-0001-7000-9000-100000000003
          type: string
        parcelInformationLineItems:
          description: Items that are contained in this parcel information
          items:
            $ref: '#/components/schemas/ParcelInformationLineItem'
          maxItems: 50
          minItems: 0
          type: array
        processRef:
          description: Reference to related process.
          example: 019eefb2-0001-7000-9000-100000000004
          type: string
        shippingInformationRef:
          description: Reference to related shipping information.
          example: 019eefb2-0001-7000-9000-100000000001
          type: string
        shortId:
          description: >-
            A short identifier that helps assigning a parcelInformation to a
            customer
          example: FT-01
          type: string
        version:
          description: Version number of this parcelInformation
          example: 1
          type: integer
        weights:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationWeights'
          description: Weight information of this parcel information
      required:
        - id
        - version
        - created
        - lastModified
        - processRef
        - operativeProcessRef
        - facilityRef
        - shippingInformationRef
        - parcelInformationLineItems
      title: ParcelInformation
      type: object
      description: ParcelInformation
    ParcelInformationDimensions:
      properties:
        decimalPlaces:
          description: The number of decimal places the dimensions have. Max value is 2
          example: 0
          maximum: 2
          minimum: 0
          type: integer
        height:
          description: The height of the parcel without decimal places
          example: 30
          minimum: 1
          type: integer
        length:
          description: The length of the parcel without decimal places
          example: 40
          minimum: 1
          type: integer
        unit:
          description: The unit of the dimensions. For now only CENTIMETER is supported
          enum:
            - CENTIMETER
          example: CENTIMETER
          type: string
        width:
          description: The width of the parcel without decimal places
          example: 20
          minimum: 1
          type: integer
      required:
        - height
        - width
        - length
        - unit
        - decimalPlaces
      title: ParcelInformationDimensions
      type: object
      description: ParcelInformationDimensions
    ParcelInformationForCreation:
      properties:
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        dimensions:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationDimensions'
          description: Dimension information of this parcel information
        parcelInformationLineItems:
          description: Items that are contained in this parcel information
          items:
            $ref: '#/components/schemas/ParcelInformationLineItemForCreation'
          maxItems: 50
          minItems: 0
          type: array
        shippingInformationRef:
          description: Reference to related shipping information.
          example: 019eefb2-0001-7000-9000-100000000001
          type: string
        shortId:
          description: >-
            A short identifier that helps assigning a parcelInformation to a
            customer
          example: FT-01
          type: string
        weights:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationWeightsForCreation'
          description: Weight information of this parcel information
      required:
        - shippingInformationRef
        - parcelInformationLineItems
      title: ParcelInformationForCreation
      type: object
      description: ParcelInformationForCreation
    ParcelInformationLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/LineItemArticle'
          description: Article information for this line item.
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities. If not passed, a new one will be
            generated.
          example: 019eefb2-0001-7000-9000-200000000002
          type: string
        id:
          description: Unique identifier of this parcelInformationLineItem
          example: 019eefb2-0001-7000-9000-200000000001
          type: string
        quantity:
          description: Quantity of this item
          example: 2
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the item that can be set during the
            process
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          maxItems: 50
          minItems: 0
          type: array
        scannableCodes:
          description: Codes, that identify the article
          example:
            - '4006381333931'
          items:
            type: string
          maxItems: 50
          minItems: 0
          type: array
      required:
        - id
        - article
        - quantity
      title: ParcelInformationLineItem
      type: object
      description: ParcelInformationLineItem
    ParcelInformationLineItemForCreation:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/LineItemArticle'
          description: Article information for this line item.
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities. If not passed, a new one will be
            generated.
          example: 019eefb2-0001-7000-9000-200000000002
          type: string
        quantity:
          description: Quantity of this item
          example: 2
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the item that can be set during the
            process
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          minItems: 0
          type: array
        scannableCodes:
          description: Codes, that identify the article
          example:
            - '4006381333931'
          items:
            type: string
          maxItems: 50
          minItems: 0
          type: array
      required:
        - article
        - quantity
      title: ParcelInformationLineItemForCreation
      type: object
      description: ParcelInformationLineItemForCreation
    ParcelInformationListResponse:
      properties:
        parcelInformationList:
          description: the parcel information found by the given search criteria
          items:
            $ref: '#/components/schemas/ParcelInformation'
          maxItems: 500
          type: array
        total:
          description: >-
            the total count of parcel information found by the given search
            criteria
          example: 42
          type: integer
      title: ParcelInformationListResponse
      type: object
      description: ParcelInformationListResponse
    ParcelInformationPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        parcelInformationList:
          items:
            $ref: '#/components/schemas/ParcelInformation'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - parcelInformationList
      title: ParcelInformationPaginatedResult
      type: object
      description: ParcelInformationPaginatedResult
    ParcelInformationParcelInformationLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by title
      title: ParcelInformationParcelInformationLineItemsArticleFilter
      type: object
      description: ParcelInformationParcelInformationLineItemsArticleFilter
    ParcelInformationParcelInformationLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: >-
                #/components/schemas/ParcelInformationParcelInformationLineItemsArticleFilter
          description: Nested search by article
      title: ParcelInformationParcelInformationLineItemsFilter
      type: object
      description: ParcelInformationParcelInformationLineItemsFilter
    ParcelInformationParcelInformationLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ParcelInformationParcelInformationLineItemsFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ParcelInformationParcelInformationLineItemsListFilter
      type: object
      description: ParcelInformationParcelInformationLineItemsListFilter
    ParcelInformationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ParcelInformationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ParcelInformationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ParcelInformationSearchPayload
      type: object
      description: ParcelInformationSearchPayload
    ParcelInformationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ParcelInformationSearchQuery'
          maxItems: 500
          type: array
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/ParcelInformationSearchQuery'
          maxItems: 500
          type: array
        parcelInformationLineItems:
          allOf:
            - $ref: >-
                #/components/schemas/ParcelInformationParcelInformationLineItemsListFilter
          description: Nested list search by parcelInformationLineItems
        shippingInformationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shippingInformationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        shortId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shortId
      title: ParcelInformationSearchQuery
      type: object
      description: ParcelInformationSearchQuery
    ParcelInformationSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: ParcelInformationSort
      type: object
      description: ParcelInformationSort
    ParcelInformationWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ParcelInformation'
      required:
        - payload
      type: object
      title: ParcelInformationWebHookEvent
      description: ParcelInformationWebHookEvent
    ParcelInformationWeight:
      properties:
        decimalPlaces:
          description: The number of decimal places the weight has. Max value is 3
          example: 0
          maximum: 3
          minimum: 0
          type: integer
        unit:
          description: The unit of the weight. For now only GRAM is supported
          enum:
            - GRAM
          example: GRAM
          type: string
        weight:
          description: The weight of the parcel without decimal places.
          example: 500
          minimum: 1
          type: integer
      required:
        - unit
        - decimalPlaces
        - weight
      title: ParcelInformationWeight
      type: object
      description: ParcelInformationWeight
    ParcelInformationWeights:
      properties:
        autoCalculated:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationWeight'
          description: >-
            Weight automatically calculated from the line items of this parcel
            information. The weights per item are taken from article.attributes
            (category: dimensions, key: weightPerUnit, type: NUMBER). Only if
            ALL items have this attribute a weight will be calculated. If at
            least one item does not have this attribute, autoCalculated will not
            be set.
        manuallySet:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationWeight'
          description: Weight manually set for this parcel information
      title: ParcelInformationWeights
      type: object
      description: ParcelInformationWeights
    ParcelInformationWeightsForCreation:
      properties:
        manuallySet:
          allOf:
            - $ref: '#/components/schemas/ParcelInformationWeight'
          description: Weight manually set for this parcel information
      required:
        - manuallySet
      title: ParcelInformationWeightsForCreation
      type: object
      description: ParcelInformationWeightsForCreation
    ParcelInvoiceFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: ParcelInvoiceFilter
      type: object
      description: ParcelInvoiceFilter
    ParcelItem:
      allOf:
        - $ref: '#/components/schemas/LineItem'
        - properties:
            article:
              $ref: '#/components/schemas/ParcelItemArticle'
            countryOfManufacture:
              deprecated: true
              description: Deprecated - use article.attribute.countryOfManufacture instead
              type: string
            description:
              deprecated: true
              description: >-
                Description - article.title will be used instead - of the given
                item/items
              example: Item Description
              type: string
            hsCode:
              deprecated: true
              description: Deprecated - use article.attribute.hsCode instead
              maxLength: 50
              type: string
            id:
              description: The id of this parcelItem.
              example: ae3ba67c-a42c-4816-96ac-16231e49640c
              type: string
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            parcelItemValue:
              allOf:
                - $ref: '#/components/schemas/ParcelItemValue'
              deprecated: true
              description: >-
                Deprecated - use article.attribute.pricePerUnit and
                article.attribute.currency instead
            quantity:
              description: amount of the given items
              example: 5
              minimum: 1
              type: integer
            weightInGram:
              deprecated: true
              description: >-
                Deprecated - use article.attribute.weightPerUnit instead -
                Weight of a single item in gram
              example: 10000
              type: integer
          required:
            - id
            - quantity
          type: object
      xml:
        name: ParcelItem
      title: ParcelItem
      description: ParcelItem
    ParcelItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              maxItems: 40
              type: array
          type: object
      xml:
        name: ParcelItemArticle
      title: ParcelItemArticle
      description: ParcelItemArticle
    ParcelItemForCreation:
      allOf:
        - $ref: '#/components/schemas/LineItemForCreation'
      properties:
        article:
          $ref: '#/components/schemas/ParcelItemArticle'
        countryOfManufacture:
          deprecated: true
          description: Deprecated - use article.attribute.countryOfManufacture instead
          type: string
        description:
          description: Description of the given item/items
          example: Item Description
          type: string
        hsCode:
          deprecated: true
          description: Deprecated - use article.attribute.hsCode instead
          maxLength: 50
          type: string
        parcelItemValue:
          allOf:
            - $ref: '#/components/schemas/ParcelItemValue'
          deprecated: true
          description: >-
            Deprecated - use article.attribute.pricePerUnit and
            article.attribute.currency instead
        quantity:
          description: amount of the given items
          example: 5
          minimum: 1
          type: integer
        weightInGram:
          deprecated: true
          description: >-
            Weight of a single item in gram. Deprecated - Use
            article.attribute.weightPerUnit instead
          example: 10000
          type: integer
      required:
        - quantity
      type: object
      xml:
        name: ParcelItemForCreation
      title: ParcelItemForCreation
      description: ParcelItemForCreation
    ParcelItemForUpdate:
      additionalProperties: false
      properties:
        id:
          description: >-
            The id of this parcelItem. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: ae3ba67c-a42c-4816-96ac-16231e49640c
          type: string
        parcelItemArticleAttributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 40
          type: array
        parcelItemValue:
          $ref: '#/components/schemas/ParcelItemValue'
          deprecated: true
          description: >-
            Deprecated - use article.attribute.pricePerUnit and
            article.attribute.currency instead
        weightInGram:
          description: Weight of a single item in gram
          example: 10000
          nullable: true
          type: integer
      required:
        - id
      type: object
      title: ParcelItemForUpdate
      description: ParcelItemForUpdate
    ParcelItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by title
      title: ParcelItemsArticleFilter
      type: object
      description: ParcelItemsArticleFilter
    ParcelItemsFilter:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ParcelItemsArticleFilter'
          description: Nested search by article
      title: ParcelItemsFilter
      type: object
      description: ParcelItemsFilter
    ParcelItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ParcelItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ParcelItemsListFilter
      type: object
      description: ParcelItemsListFilter
    ParcelItemValue:
      description: >-
        deprecated, use
        MandatoryShippingArticleAttribute.attributes.pricePerUnit instead
      nullable: true
      properties:
        currency:
          description: Currency of the given value
          example: EUR
          type: string
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          type: integer
        type:
          $ref: '#/components/schemas/ProductValueType'
        value:
          description: Monetary Value of a single item in the given currency
          example: 15.5
          type: number
      required:
        - value
        - currency
      type: object
      title: ParcelItemValue
    ParcelLabelClassification:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized name for parcel label classification
          example:
            de_DE: S-Paket
            en_US: S-Parcel
            ru_RU: S-пакет
        dimensions:
          allOf:
            - $ref: '#/components/schemas/ParcelDimensions'
          description: Dimensions for this parcel label classification
        name:
          description: Name of the parcel label classification
          example: S-Parcel
          type: string
        services:
          allOf:
            - $ref: '#/components/schemas/ParcelLabelClassificationServices'
          description: Services available for this parcel label classification
      required:
        - nameLocalized
        - dimensions
      title: ParcelLabelClassification
      type: object
      description: ParcelLabelClassification
    ParcelLabelClassificationForCreation:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: Localized name for parcel label classification
          example:
            de_DE: S-Paket
            en_US: S-Parcel
            ru_RU: S-пакет
        dimensions:
          allOf:
            - $ref: '#/components/schemas/ParcelDimensions'
          description: Dimensions for this parcel label classification
        services:
          allOf:
            - $ref: '#/components/schemas/ParcelLabelClassificationServices'
          description: Services available for this parcel label classification
      required:
        - nameLocalized
        - dimensions
      title: ParcelLabelClassificationForCreation
      type: object
      description: ParcelLabelClassificationForCreation
    ParcelLabelClassificationServices:
      properties:
        bulkyGoods:
          default: false
          description: Indicates if this label classification is for bulky goods
          type: boolean
      title: ParcelLabelClassificationServices
      type: object
      description: ParcelLabelClassificationServices
    ParcelLabelCreationFailedPayload:
      allOf:
        - $ref: '#/components/schemas/OperativeEntityPayloadBase'
      properties:
        errorMessage:
          type: string
      required:
        - errorMessage
      type: object
      title: ParcelLabelCreationFailedPayload
      description: ParcelLabelCreationFailedPayload
    ParcelLabelType:
      description: Which kind of label you want to add to the parcel
      enum:
        - SEND_LABEL
        - RETURN_LABEL
      type: string
      title: ParcelLabelType
    ParcelLabelTypeEnum:
      description: The type of possible Parcel Labels
      enum:
        - return.pdf
        - all.pdf
        - send.pdf
        - customs.pdf
        - return.zpl
        - all.zpl
        - send.zpl
        - customs.zpl
      type: string
      title: ParcelLabelTypeEnum
    ParcelPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        parcels:
          items:
            $ref: '#/components/schemas/Parcel'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - parcels
      title: ParcelPaginatedResult
      type: object
      description: ParcelPaginatedResult
    ParcelPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyParcel'
              - $ref: '#/components/schemas/ModifyParcelLoadUnit'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: ParcelPatchActions
      title: ParcelPatchActions
      description: ParcelPatchActions
    ParcelPickUpInformation:
      additionalProperties: false
      nullable: true
      properties:
        endTime:
          description: needs to be after start time
          format: date-time
          type: string
        startTime:
          description: needs to be before end time
          format: date-time
          type: string
      required:
        - startTime
        - endTime
      type: object
      xml:
        name: ParcelItemForCreation
      title: ParcelPickUpInformation
      description: ParcelPickUpInformation
    ParcelPostalCharge:
      properties:
        currency:
          description: Currency of the given value
          example: EUR
          type: string
        value:
          description: Monetary Value in the given currency
          example: 15.5
          type: number
      required:
        - currency
        - value
      title: ParcelPostalCharge
      description: ParcelPostalCharge
    ParcelProductValue:
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          nullable: true
          type: string
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          minimum: 0
          type: integer
        value:
          description: >-
            Total value that should be shipped. Value is configured in the
            smallest subunit, e.g. cents.
          example: 25000
          minimum: 1
          type: integer
      required:
        - value
        - currency
        - decimalPlaces
      type: object
      title: ParcelProductValue
      description: ParcelProductValue
    ParcelRecipientFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: ParcelRecipientFilter
      type: object
      description: ParcelRecipientFilter
    ParcelResult:
      description: >-
        Within this object you can find the result of the request after it has
        been processed (status = DONE or FAILED)
      properties:
        carrierParcelRef:
          description: The reference number of the parcel by the carrier
          example: '84168117830018'
          maxLength: 120
          minLength: 1
          type: string
        carrierTrackingNumber:
          example: '84168117830018'
          type: string
        carrierTrackingStatus:
          oneOf:
            - $ref: '#/components/schemas/TrackingStatus'
            - $ref: '#/components/schemas/DhlTrackingStatus'
        customsDocumentId:
          description: The customs document id
          example: 3a186c51d4281acbecf5ed38805b1db92a9d668b
          type: string
        customsDocumentUrl:
          description: The original customs document URL
          example: someCepProvider.com/pathToReturnLabel.pdf
          type: string
        errors:
          additionalProperties: false
          description: >-
            temporary field to show errors during parcel creation, will be
            removed in the future. used to create summary in error case
          properties:
            labelError:
              type: string
            returnLabelError:
              type: string
          type: object
        labelUrl:
          description: >-
            The URL where you can download the label relative to the path of
            this resource
          example: '%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf'
          type: string
        proxyId:
          description: The ID of the corresponding job at the CEP proxy (if used)
          example: 3a186c51d4281acbecf5ed38805b1db92a9d668b
          type: string
        returnLabelId:
          description: The original return label id
          example: 3a186c51d4281acbecf5ed38805b1db92a9d668b
          type: string
        returnLabelUrl:
          description: The original return label URL
          example: someCepProvider.com/pathToReturnLabel.pdf
          type: string
        returnTrackingUrl:
          description: The URL to track the return of this parcel
          example: http://track.io/3a186c51d4
          type: string
        sendLabelUrl:
          description: The original send label URL
          example: someCepProvider.com/pathToSendLabel.pdf
          type: string
        summary:
          description: Summary of the result of the request in a human readable form.
          example: Package label was successfully requested at DHL.
          type: string
        trackingStatus:
          $ref: '#/components/schemas/TrackingStatus'
        trackingUrl:
          description: The URL to track this parcel
          example: http://track.io/3a186c51d4
          type: string
      required:
        - summary
      type: object
      title: ParcelResult
    ParcelResultFilter:
      properties:
        carrierTrackingNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierTrackingNumber
      title: ParcelResultFilter
      type: object
      description: ParcelResultFilter
    ParcelSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ParcelSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ParcelSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ParcelSearchPayload
      type: object
      description: ParcelSearchPayload
    ParcelSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ParcelSearchQuery'
          maxItems: 500
          type: array
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        invoice:
          allOf:
            - $ref: '#/components/schemas/ParcelInvoiceFilter'
          description: Nested search by invoice
        items:
          allOf:
            - $ref: '#/components/schemas/ParcelItemsListFilter'
          description: Nested list search by items
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/ParcelSearchQuery'
          maxItems: 500
          type: array
        recipient:
          allOf:
            - $ref: '#/components/schemas/ParcelRecipientFilter'
          description: Nested search by recipient
        result:
          allOf:
            - $ref: '#/components/schemas/ParcelResultFilter'
          description: Nested search by result
        shipmentRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shipmentRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        shortId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shortId
        status:
          allOf:
            - $ref: '#/components/schemas/ParcelStatusEnumFilter'
          description: Search by status
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: ParcelSearchQuery
      type: object
      description: ParcelSearchQuery
    ParcelServices:
      additionalProperties: false
      nullable: true
      properties:
        additionalTransportInsurance:
          description: Additional insurance for the parcel by the carrier
          type: boolean
        adultSignature:
          description: Signature from some adult
          type: boolean
        bulkyGoods:
          type: boolean
        customerSignature:
          description: Signature from the ordering customer needed
          type: boolean
        handoverToRecipientOnly:
          description: Handover person on delivery can only be the given customer
          type: boolean
        identityAgeCheck18:
          description: Minimum age the receiving person has to have (18 years)
          type: boolean
        identityCheckCompany:
          description: Identity check that can be done by a person of receiving company
          type: boolean
        identityCheckPrivate:
          description: Identity check that can be done by the receiving person
          type: boolean
        noNeighborDelivery:
          description: >-
            Forbid delivery to neighbors, only allow delivery to the given
            address
          type: boolean
        saturdayDelivery:
          description: Saturday Delivery
          type: boolean
        signature:
          description: Signature from anyone needed
          type: boolean
      type: object
      title: ParcelServices
      description: ParcelServices
    ParcelSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: ParcelSort
      type: object
      description: ParcelSort
    ParcelSplitItemsActionEnum:
      enum:
        - SPLIT_LINES_PARCEL
      type: string
      title: ParcelSplitItemsActionEnum
      description: ParcelSplitItemsActionEnum
    ParcelSplitItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ParcelSplitItemsActionEnum'
        splitItemsInfo:
          items:
            $ref: '#/components/schemas/ParcelSplitItemsInfo'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - splitItemsInfo
      title: ParcelSplitItemsActionParameter
      type: object
      description: ParcelSplitItemsActionParameter
    ParcelSplitItemsInfo:
      additionalProperties: false
      properties:
        itemId:
          description: references the id of the item of a parcel
          type: string
        quantity:
          description: quantity of the specific item that has been ordered
          example: 21
          minimum: 1
          type: integer
      required:
        - itemId
        - quantity
      type: object
      title: ParcelSplitItemsInfo
      description: ParcelSplitItemsInfo
    ParcelStatus:
      enum:
        - OPEN
        - PROCESSING
        - DONE
        - FAILED
        - CANCELED
        - OBSOLETE
        - WAITING_FOR_INPUT
      type: string
      title: ParcelStatus
      description: ParcelStatus
    ParcelStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - PROCESSING
            - DONE
            - FAILED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - PROCESSING
              - DONE
              - FAILED
              - CANCELED
              - OBSOLETE
              - WAITING_FOR_INPUT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - PROCESSING
            - DONE
            - FAILED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
          type: string
      title: ParcelStatusEnumFilter
      type: object
      description: ParcelStatusEnumFilter
    ParcelTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagConfiguration'
      properties:
        alternativeReturnAddressConfiguration:
          $ref: '#/components/schemas/AlternativeReturnAddressConfiguration'
      required:
        - alternativeReturnAddressConfiguration
      title: ParcelTagConfiguration
      description: ParcelTagConfiguration
    ParcelTagConfigurationForUpsert:
      allOf:
        - $ref: '#/components/schemas/TagConfiguration'
      properties:
        alternativeReturnAddressConfiguration:
          $ref: '#/components/schemas/AlternativeReturnAddressConfiguration'
        version:
          example: 0
          type: number
      required:
        - alternativeReturnAddressConfiguration
      title: ParcelTagConfigurationForUpsert
      description: ParcelTagConfigurationForUpsert
    ParcelTrackingData:
      additionalProperties: false
      properties:
        carrierStatus:
          description: Optional additional carrier tracker information
          example: Waiting for Pickup at Parcel Shop
          type: string
        status:
          $ref: '#/components/schemas/ParcelTrackingDataStatusEnum'
        trackingNumber:
          description: '123456789'
          example: 42
          type: string
        type:
          $ref: '#/components/schemas/ParcelTrackingDataType'
      required:
        - type
        - status
        - trackingNumber
      title: ParcelTrackingData
      type: object
      description: ParcelTrackingData
    ParcelTrackingDataStatusEnum:
      description: Status of the given enum to be mapped onto the found parcel
      enum:
        - DELIVERED
        - PICKED_UP
      type: string
      title: ParcelTrackingDataStatusEnum
    ParcelTrackingDataType:
      description: Which kind of tracking data you want to add to the parcel label
      enum:
        - SEND_LABEL
        - RETURN_LABEL
      type: string
      title: ParcelTrackingDataType
    ParcelUpdateTrackingDataActionEnum:
      enum:
        - UPDATE_TRACKING_DATA
      type: string
      title: ParcelUpdateTrackingDataActionEnum
      description: ParcelUpdateTrackingDataActionEnum
    ParcelUpdateTrackingDataActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ParcelUpdateTrackingDataActionEnum'
        trackingData:
          items:
            anyOf:
              - $ref: '#/components/schemas/ParcelTrackingData'
          maxItems: 2
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - trackingData
      title: ParcelUpdateTrackingDataActionParameter
      type: object
      description: ParcelUpdateTrackingDataActionParameter
    ParcelWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Parcel'
      required:
        - payload
      type: object
      title: ParcelWebHookEvent
      description: ParcelWebHookEvent
    PartialStock:
      allOf:
        - $ref: '#/components/schemas/PartialStockForCreation'
      properties:
        eventLastModified:
          description: >-
            The date when the inventory domain comunicated a change in this
            partial stock
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        stockinformation:
          $ref: '#/components/schemas/StockInformation'
      required:
        - tenantPartialStockId
        - stockinformation
      type: object
      xml:
        name: PartialStock
      title: PartialStock
      description: PartialStock
    PartialStockForCreation:
      additionalProperties: false
      properties:
        location:
          $ref: '#/components/schemas/Location'
        scores:
          items:
            $ref: '#/components/schemas/Score'
          type: array
        stockinformation:
          $ref: '#/components/schemas/StockInformationForCreation'
        tenantPartialStockId:
          description: The id associated with the partial stock
          type: string
      required:
        - tenantPartialStockId
        - stockinformation
      type: object
      xml:
        name: PartialStock
      title: PartialStockForCreation
      description: PartialStockForCreation
    PartialStockLocation:
      properties:
        stockRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        tenantPartialStockId:
          type: string
      required:
        - tenantPartialStockId
        - stockRef
      title: PartialStockLocation
      type: object
      description: PartialStockLocation
    PartialStockPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyPartialStock'
          maxItems: 1
          minItems: 1
          type: array
        version:
          description: >-
            The version of the listing where we want to patch the partialStocks,
            to be used in optimistic locking mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: PartialStockPatchActions
      title: PartialStockPatchActions
      description: PartialStockPatchActions
    PartialStocksForReplacement:
      additionalProperties: false
      properties:
        partialStocks:
          items:
            $ref: '#/components/schemas/PartialStockForCreation'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the listing where we want to put the partialStocks,
            to be used in optimistic locking mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - partialStocks
        - version
      type: object
      xml:
        name: PartialStocksForReplacement
      title: PartialStocksForReplacement
      description: PartialStocksForReplacement
    PauseItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - PauseItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: PauseItemReturnActionParameter
      type: object
      description: PauseItemReturnActionParameter
    PausePackJob:
      additionalProperties: false
      description: Action to pause a PackJob
      properties:
        action:
          description: Use value 'PausePackJob', because you want to pause a packjob
          enum:
            - PausePackJob
          type: string
        packLineItemsUpdate:
          items:
            $ref: '#/components/schemas/PackLineItemForUpdate'
          type: array
      required:
        - action
      title: PausePackJob
      type: object
      xml:
        name: PausePackJob
    PauseStowJobAction:
      description: Sets the status of the stowjob to PAUSED
      properties:
        name:
          description: The name of the action that should be performed
          enum:
            - PAUSE_STOW_JOB
          type: string
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
      title: PauseStowJobAction
      type: object
    PaymentInformation:
      properties:
        currency:
          description: The currency in which the consumer paid with
          example: EUR
          type: string
      type: object
      title: PaymentInformation
      description: PaymentInformation
    PdfBackgroundConfiguration:
      properties:
        firstPageBackgroundFileUrl:
          description: >-
            File url of the background image that will be used for the first
            page
          type: string
        followingPageBackgroundFileUrl:
          description: File url of background image that will be used for 2-n pages
          type: string
      type: object
      title: PdfBackgroundConfiguration
      description: PdfBackgroundConfiguration
    PdfBackgroundConfigurationForUpsert:
      properties:
        firstPageBackgroundFile:
          $ref: '#/components/schemas/NamedFile'
        followingPageBackgroundFile:
          $ref: '#/components/schemas/NamedFile'
      type: object
      title: PdfBackgroundConfigurationForUpsert
      description: PdfBackgroundConfigurationForUpsert
    Permission:
      properties:
        description:
          description: The localized description of the permission
          type: string
        group:
          description: The group of the permission
          enum:
            - INVENTORY
            - ORDER_MANAGEMENT
            - SYSTEM_ADMINISTRATION
            - FOUNDATION
            - USER_MANAGEMENT
            - OPERATIONS
            - ADMIN
            - CORE
          type: string
        key:
          description: The key of the permission
          enum:
            - USER_READ
            - USERS_READ
            - USER_WRITE
            - USER_MODIFY
            - CURRENT_USER_READ
            - CURRENT_USER_MODIFY
            - ROLE_READ
            - ROLE_WRITE
            - FACILITY_READ
            - FACILITY_WRITE
            - FACILITY_CREATE
            - FACILITY_DELETE
            - FACILITY_GROUP_READ
            - FACILITY_GROUP_WRITE
            - ORDER_READ
            - ORDER_WRITE
            - ORDER_FORCE_CANCEL
            - ORDER_UNLOCK
            - ORDER_CANCEL
            - ORDER_CONSUMER_WRITE
            - ORDER_CUSTOM_ATTRIBUTES_WRITE
            - ORDER_LINEITEM_WRITE
            - ORDER_TOTAL_READ
            - LINE_ITEM_PRICING_READ
            - LINE_ITEM_QUANTITY_INCREASE
            - LINE_ITEM_ADD
            - LINE_ITEM_QUANTITY_DECREASE
            - LINE_ITEM_DELETE
            - SIMULATION_ORDER_READ
            - SIMULATION_ORDER_WRITE
            - AUDIT_READ
            - NOTIFICATION_READ
            - NOTIFICATION_WRITE
            - EXPIRIES_READ
            - EXPIRIES_WRITE
            - CONFIG_READ
            - CONFIG_WRITE
            - ROUTING_CONFIG_READ
            - ROUTING_CONFIG_WRITE
            - PROMISES_CONFIG_READ
            - PROMISES_CONFIG_WRITE
            - OIDC_PROVIDERS_CONFIG_READ
            - OIDC_PROVIDERS_CONFIG_WRITE
            - LOCALE_WRITE
            - CARRIER_READ
            - CARRIER_WRITE
            - RETURN_WRITE
            - RETURN_READ
            - ROUTING_READ
            - ROUTING_WRITE
            - PARCEL_READ
            - PARCEL_WRITE
            - SHIPMENT_READ
            - SHIPMENT_WRITE
            - HANDOVERJOB_READ
            - HANDOVERJOB_WRITE
            - PICKJOB_READ
            - PICKJOB_WRITE
            - PICKJOB_REROUTE
            - REMOTE_CONFIG_READ
            - REMOTE_CONFIG_WRITE
            - PICKRUN_READ
            - PICKRUN_WRITE
            - LOADUNITTYPE_READ
            - LOADUNITTYPE_WRITE
            - LOADUNIT_READ
            - LOADUNIT_WRITE
            - MEASUREMENTUNIT_READ
            - MEASUREMENTUNIT_WRITE
            - EVENT_READ
            - SUBSCRIPTION_READ
            - SUBSCRIPTION_WRITE
            - SUBSTITUTE_READ
            - SUBSTITUTE_WRITE
            - PROCESS_READ
            - PROCESS_WRITE
            - PROCESS_REROUTE
            - EXTERNAL_ACTIONS_READ
            - EXTERNAL_ACTIONS_WRITE
            - PROCESS_LOG_READ
            - OPERATIVE_PROCESS_READ
            - OPERATIVE_PROCESS_WRITE
            - DELIVERYNOTE_WRITE
            - PACKJOB_READ
            - PACKJOB_WRITE
            - PACKINGCONTAINER_TYPE_WRITE
            - PACKING_SOURCE_CONTAINER_READ
            - PACKING_SOURCE_CONTAINER_WRITE
            - RESTOW_ITEM_READ
            - RESTOW_ITEM_WRITE
            - TAG_READ
            - TAG_WRITE
            - STOCK_READ
            - STOCK_WRITE
            - EXTERNAL_STOCK_CHANGE_REASONS_READ
            - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
            - STORAGE_LOCATION_READ
            - STORAGE_LOCATION_WRITE
            - STOW_JOB_READ
            - STOW_JOB_OPERATIVE_WRITE
            - STOW_JOB_FULL_WRITE
            - NOTIFICATION_CENTER_CONFIG_READ
            - NOTIFICATION_CENTER_CONFIG_WRITE
            - DOMS_TOOLKIT_READ
            - DOMS_TOOLKIT_WRITE
            - ANALYTICS_DASHBOARD_READ
            - DOCUMENT_SET_READ
            - DOCUMENT_SET_WRITE
            - INBOUND_PROCESS_READ
            - INBOUND_PROCESS_WRITE
            - ADMIN_DATA_RESET
            - ADMIN_MODULES_READ
            - ADMIN_MODULES_WRITE
            - TENANT_CONNECTOR_CONFIG_READ
            - CUSTOM_SERVICE_WRITE
            - CUSTOM_SERVICE_READ
            - VALIDATIONS_READ
            - SERVICE_JOB_READ
            - SERVICE_JOB_WRITE
            - LINKED_SERVICE_JOBS_READ
            - LINKED_SERVICE_JOBS_WRITE
            - OPERATION_STATISTICS_READ
            - DOMS_STATISTICS_READ
            - AVAILABILITY_CHANNEL_READ
            - AVAILABILITY_CHANNEL_WRITE
            - HANDOVER_CONTAINER_READ
            - HANDOVER_CONTAINER_WRITE
            - STACKS_READ
            - STACKS_WRITE
            - CATEGORY_READ
            - CATEGORY_WRITE
            - PERMISSION_READ
            - KPI_READ
            - AI_ASSISTANT_ACCESS
            - RESERVATION_WRITE
            - RESERVATION_READ
            - FILTER_ENTITY_READ
            - BRAND_READ
            - WORKFLOW_DEFINITION_READ
            - WORKFLOW_DEFINITION_WRITE
            - LOOKUP_RECORD_READ
            - LOOKUP_RECORD_WRITE
            - ORDER_RECORD_READ
            - ORDER_RECORD_WRITE
            - PACKAGING_UNITS_READ
            - PACKAGING_UNITS_WRITE
            - EXPORT_READ
            - EXPORT_WRITE
            - STOCK_AVAILABILITIES_READ
            - LISTING_READ
            - LISTING_WRITE
            - LISTING_DELETE
            - PURCHASE_PRICE_READ
            - ZONE_READ
            - ZONE_WRITE
            - SAFETY_STOCK_READ
            - SAFETY_STOCK_WRITE
          type: string
        operation:
          description: The operation of the permission
          enum:
            - READ
            - WRITE
            - DELETE
            - REROUTE
            - LIST
            - MODIFY
            - CREATE
            - RESET
            - FORCE_CANCEL
            - UNLOCK
            - CANCEL
            - CONSUMER_WRITE
            - CUSTOM_ATTRIBUTES_WRITE
            - LINEITEM_WRITE
            - TOTAL_READ
            - PRICING_READ
            - QUANTITY_INCREASE
            - QUANTITY_DECREASE
            - ADD
          type: string
        subGroup:
          description: The subgroup of the permission
          enum:
            - ORDER
            - LINE_ITEM
            - SIMULATION_ORDER
            - USER
            - CURRENT_USER
            - ROLE
            - EXPIRY
            - AUDIT
            - FACILITY
            - FACILITY_GROUP
            - CONFIG
            - ROUTING_CONFIG
            - ROUTING
            - OIDC_PROVIDER_CONFIG
            - PROMISES_CONFIG
            - LOCALE
            - CARRIER
            - RETURN
            - PARCEL
            - SHIPMENT
            - HANDOVERJOB
            - HANDOVER_JOB
            - PICKJOB
            - PICK_JOB
            - PICKRUN
            - PICK_RUN
            - PACKJOB
            - PACK_JOB
            - PACKING_SOURCE_CONTAINER
            - PACKINGCONTAINER_TYPE
            - PACKING_CONTAINER_TYPE
            - RESTOW_ITEM
            - TAG
            - STOCK
            - EXTERNAL_STOCK_CHANGE_REASONS
            - STORAGE_LOCATION
            - STOW_JOB
            - NOTIFICATION
            - NOTIFICATION_CENTER_CONFIG
            - DOMS_TOOLKIT
            - ANALYTICS_DASHBOARD
            - DOCUMENT_SET
            - INBOUND_PROCESS
            - TENANT_CONNECTOR_CONFIG
            - ADMIN_MODULES
            - CUSTOM_SERVICE
            - VALIDATIONS
            - SERVICE_JOB
            - LINKED_SERVICE_JOBS
            - OPERATION_STATISTICS
            - DOMS_STATISTICS
            - AVAILABILITY_CHANNEL
            - HANDOVER_CONTAINER
            - STACKS
            - CATEGORY
            - PERMISSION
            - AI_SIDEKICK
            - KPI
            - LOADUNIT_TYPE
            - LOAD_UNIT_TYPE
            - LOADUNIT
            - LOAD_UNIT
            - MEASUREMENT_UNIT
            - EVENT
            - SUBSCRIPTION
            - SUBSTITUTE
            - PROCESS
            - PROCESS_LOGS
            - EXTERNAL_ACTIONS
            - OPERATIVE_PROCESS
            - DELIVERYNOTE
            - REMOTE_CONFIG
            - ADMIN_DATA
            - RESERVATION
            - FILTER_ENTITY
            - BRAND
            - WORKFLOW_DEFINITION
            - LOOKUP_RECORD
            - ORDER_RECORD
            - PACKAGING_UNITS
            - EXPORT
            - STOCK_AVAILABILITIES
            - LISTING
            - PURCHASE_PRICE
            - ZONE
            - SAFETY_STOCK
          type: string
      required:
        - operation
        - key
        - group
        - subGroup
      title: Permission
      type: object
      description: Permission
    PermissionsResponse:
      properties:
        permissions:
          description: The list of permissions
          items:
            $ref: '#/components/schemas/Permission'
          type: array
        total:
          description: The total number of (filtered) permissions
          type: number
      required:
        - permissions
        - total
      title: PermissionsResponse
      type: object
      description: PermissionsResponse
    PickingConfigurations:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        backofficePickingConfiguration:
          $ref: '#/components/schemas/BackofficePickingConfiguration'
        batchPickingConfiguration:
          $ref: '#/components/schemas/BatchPickingConfiguration'
        domainStatusConfiguration:
          $ref: '#/components/schemas/PickingDomainStatusConfiguration'
        loadUnitAssignmentConfiguration:
          $ref: '#/components/schemas/LoadUnitAssignmentConfiguration'
        multiOrderPickingConfiguration:
          $ref: '#/components/schemas/MultiOrderPickingConfiguration'
        pickingMethodsConfiguration:
          $ref: '#/components/schemas/PickingMethodsConfiguration'
        pickingShortPickConfiguration:
          $ref: '#/components/schemas/PickingShortPickConfiguration'
        restartPickJobConfiguration:
          $ref: '#/components/schemas/RestartPickJobConfiguration'
        scanCodeValidationConfiguration:
          $ref: '#/components/schemas/PickingScanCodeValidationConfiguration'
        scanningConfiguration:
          $ref: '#/components/schemas/PickingScanningConfiguration'
        scheduledPickJobReleaseConfiguration:
          $ref: '#/components/schemas/ScheduledPickJobReleaseConfiguration'
        stockUpdateConfiguration:
          $ref: '#/components/schemas/PickingStockUpdateConfiguration'
        storageLocationAssignmentConfiguration:
          $ref: '#/components/schemas/StorageLocationAssignmentConfiguration'
        takeOverPickJobConfiguration:
          $ref: '#/components/schemas/TakeOverPickJobConfiguration'
        takeOverPickRunConfiguration:
          $ref: '#/components/schemas/TakeOverPickRunConfiguration'
      type: object
      title: PickingConfigurations
      description: PickingConfigurations
    PickingDomainStatusConfiguration:
      additionalProperties: false
      description: Configuration for the picking status to domainStatus mapping
      properties:
        mapAbortedToFinished:
          default: false
          description: >-
            If true, the pickJob status ABORTED will be mapped to the
            domainStatus FINISHED instead of STUCK
          type: boolean
      type: object
      title: PickingDomainStatusConfiguration
    PickingLoadUnitForCreation:
      properties:
        codes:
          description: List of codes
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        loadUnitLineItems:
          items:
            $ref: '#/components/schemas/LoadUnitLineItemForCreation'
          maxItems: 100
          type: array
        loadUnitTypeRef:
          deprecated: true
          description: Use operativeContainerTypeRef instead.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        operativeContainerTypeRef:
          description: the reference to the operativeContainerType
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        stackRef:
          description: the reference to the stackRef this loadUnit is part of
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            the reference to the storage location this load unit as been placed
            into
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - codes
      title: PickingLoadUnitForCreation
      type: object
      description: PickingLoadUnitForCreation
    PickingMethodEnum:
      description: >-
        Way in which the picking should be handled Deprecated: BATCH_PICKING,
        use BATCH instead
      enum:
        - SINGLE_ORDER
        - MULTI_ORDER
        - BATCH_PICKING
        - BATCH
      example: SINGLE_ORDER
      type: string
      title: PickingMethodEnum
    PickingMethodsConfiguration:
      properties:
        defaultPickingMethod:
          $ref: '#/components/schemas/PickingMethodEnum'
      required:
        - defaultPickingMethod
      type: object
      title: PickingMethodsConfiguration
      description: PickingMethodsConfiguration
    PickingOutcomeConfigSnapshot:
      properties:
        shortPickActiveDefaulted:
          description: True when shortpick.active config was absent and defaulted to true
          type: boolean
        stockToZeroOnEmptyPartialStockLocationActive:
          description: Whether stock should be set to zero on empty partial stock location
          type: boolean
        stockToZeroOnShortPickActive:
          description: Whether stock should be set to zero on short pick
          type: boolean
      required:
        - stockToZeroOnShortPickActive
        - stockToZeroOnEmptyPartialStockLocationActive
        - shortPickActiveDefaulted
      title: PickingOutcomeConfigSnapshot
      type: object
      description: PickingOutcomeConfigSnapshot
    PickingOutcomeDiagnostic:
      properties:
        code:
          $ref: '#/components/schemas/DiagnosticCode'
      required:
        - code
      title: PickingOutcomeDiagnostic
      type: object
      description: PickingOutcomeDiagnostic
    PickingOutcomeEventPayload:
      properties:
        config:
          allOf:
            - $ref: '#/components/schemas/PickingOutcomeConfigSnapshot'
          description: Job-wide config snapshot
        header:
          $ref: '#/components/schemas/PickingOutcomeHeader'
        reasons:
          description: Unique list of all DiagnosticCodes
          items:
            $ref: '#/components/schemas/DiagnosticCode'
          type: array
        records:
          items:
            $ref: '#/components/schemas/PickingOutcomeRecord'
          type: array
      required:
        - header
        - config
        - reasons
        - records
      title: PickingOutcomeEventPayload
      type: object
      description: PickingOutcomeEventPayload
    PickingOutcomeHeader:
      properties:
        facilityRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        jobRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        jobType:
          $ref: '#/components/schemas/PickingOutcomeHeaderJobType'
        orderRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        processRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        routingPlanRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantOrderId:
          example: MY_ORDER_ID
          type: string
      required:
        - jobRef
        - facilityRef
      title: PickingOutcomeHeader
      type: object
      description: PickingOutcomeHeader
    PickingOutcomeHeaderJobType:
      description: PickingOutcome Source Trigger
      enum:
        - PICK_JOB
        - HANDOVER_JOB
        - CHAINED_SUPPLIER
      type: string
      xml:
        name: PickingOutcomeHeaderJobType
      title: PickingOutcomeHeaderJobType
    PickingOutcomeRecord:
      properties:
        diagnostics:
          items:
            $ref: '#/components/schemas/PickingOutcomeDiagnostic'
          type: array
        lineItemId:
          description: >-
            Depending on the trigger this holds the pickLineItem.id from a
            pickJob or handoverJobLineItem.id from an handoverJob
          type: string
        partialStockLocation:
          $ref: '#/components/schemas/PartialStockLocation'
        provided:
          $ref: '#/components/schemas/ProvidedSection'
        reduction:
          $ref: '#/components/schemas/ReductionSection'
        stockSelection:
          $ref: '#/components/schemas/StockSelectionSection'
        substituteLocationRef:
          type: string
      required:
        - provided
        - stockSelection
        - reduction
        - diagnostics
      title: PickingOutcomeRecord
      type: object
      description: PickingOutcomeRecord
    PickingOutcomeWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/PickingOutcomeEventPayload'
      required:
        - payload
      title: PickingOutcomeWebHookEvent
      type: object
      description: PickingOutcomeWebHookEvent
    PickingPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyPickLineItem'
              - $ref: '#/components/schemas/ModifyPickJob'
              - $ref: '#/components/schemas/ModifyPickJobLastEditor'
              - $ref: '#/components/schemas/RestartPickJob'
              - $ref: '#/components/schemas/ResetPickJob'
              - $ref: '#/components/schemas/AbortPickJob'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      xml:
        name: PickingPatchActions
      title: PickingPatchActions
      description: PickingPatchActions
    PickingScanCodeValidationConfiguration:
      properties:
        pickingScanCodeValidationType:
          $ref: '#/components/schemas/PickingScanCodeValidationEnum'
      required:
        - pickingScanCodeValidationType
      type: object
      title: PickingScanCodeValidationConfiguration
      description: PickingScanCodeValidationConfiguration
    PickingScanCodeValidationEnum:
      description: State that defines if unknown scan codes can be accepted
      enum:
        - NO_VALIDATION
        - CODE_MUST_BE_KNOWN
      type: string
      title: PickingScanCodeValidationEnum
    PickingScanningConfiguration:
      properties:
        rolesWithOverwritingScanningPermission:
          items:
            $ref: '#/components/schemas/UserRoleNames'
          minItems: 1
          type: array
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        scanningType:
          $ref: '#/components/schemas/PickingScanningConfigurationEnum'
      type: object
      title: PickingScanningConfiguration
      description: PickingScanningConfiguration
    PickingScanningConfigurationEnum:
      description: Way in which the scanning of articles during picking is enforced
      enum:
        - MUST_SCAN_FIRST
        - MUST_SCAN_EACH
        - SCAN_NOT_REQUIRED
      example: MUST_SCAN_FIRST
      type: string
      title: PickingScanningConfigurationEnum
    PickingShortPickConfiguration:
      properties:
        confirmationOnShortPick:
          default: false
          description: >-
            Does the picker needs to confirm a stock correction before adding a
            short pick
          type: boolean
        shortPickReasons:
          items:
            $ref: '#/components/schemas/ShortPickReason'
          type: array
      required:
        - confirmationOnShortPick
      type: object
      title: PickingShortPickConfiguration
      description: PickingShortPickConfiguration
    PickingStartBase:
      properties:
        carrierRef:
          type: string
        targetTime:
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - targetTime
      type: object
      title: PickingStartBase
      description: PickingStartBase
    PickingStockProperty:
      additionalProperties:
        type: string
      description: Picking Stock Property.
      example:
        color: yellow
      title: PickingStockProperty
      type: object
    PickingStockPropertyPreset:
      description: Preset of Picking Stock Property.
      properties:
        expiry:
          type: string
      title: PickingStockPropertyPreset
      type: object
    PickingStockUpdateConfiguration:
      properties:
        active:
          default: false
          description: Enable or disable stock update check for pick jobs
          type: boolean
      required:
        - active
      type: object
      title: PickingStockUpdateConfiguration
      description: PickingStockUpdateConfiguration
    PickingTimes:
      description: >-
        Time ranges defining the picking times per weekday. No overlapping
        ranges are allowed. There must be no overlaps for time ranges on a day
      properties:
        friday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
        monday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
        saturday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
        sunday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
        thursday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
        tuesday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
        wednesday:
          items:
            $ref: '#/components/schemas/TimeRange'
          type: array
      type: object
      title: PickingTimes
    PickingZone:
      description: Zones from which items can be picked
      properties:
        zoneRef:
          type: string
      required:
        - zoneRef
      type: object
      title: PickingZone
    PickJob:
      allOf:
        - $ref: '#/components/schemas/PickJobForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            assignedUsers:
              description: Assigned users for this entity
              items:
                $ref: '#/components/schemas/AssignedUser'
              type: array
            deliveryinformation:
              $ref: '#/components/schemas/PickjobDeliveryInformation'
            documentHandling:
              $ref: '#/components/schemas/DocumentHandling'
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            editor:
              $ref: '#/components/schemas/Editor'
            expectedPickLineItems:
              items:
                $ref: '#/components/schemas/ExpectedPickLineItem'
              type: array
            id:
              description: >-
                The id of this pickjob. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            pickingZones:
              items:
                $ref: '#/components/schemas/PickingZone'
              type: array
            pickLineItems:
              items:
                $ref: '#/components/schemas/PickLineItem'
              type: array
            pickRunRef:
              description: Pick run id to which the pick job belongs
              type: string
            resetBlocked:
              default: false
              description: Indicates if pickJob can still be resetted or restarted
              type: boolean
            shortId:
              description: >-
                A short identifier that helps assigning a pickJob to a customer.
                This is automatically created during creation.
              example: AS12
              type: string
            status:
              $ref: '#/components/schemas/PickJobStatus'
            statusReason:
              deprecated: true
              description: >-
                deprecated: Use subStatus instead. Maintained for backward
                compatibility.
              type: string
            subStatus:
              $ref: '#/components/schemas/PickJobSubStatus'
              description: The reason for the current status.
            usersModificationHistory:
              items:
                $ref: '#/components/schemas/UserModificationHistory'
              type: array
            workflowInformation:
              oneOf:
                - $ref: '#/components/schemas/WorkflowInformation'
                - $ref: '#/components/schemas/WorkflowUnavailable'
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              minItems: 1
              type: array
          required:
            - id
            - status
            - pickLineItems
            - shortId
            - workflowInformation
            - deliveryinformation
            - documentsRef
          type: object
      title: PickJob
      description: PickJob
    PickJobAbortActionEnum:
      enum:
        - ABORT
      type: string
      title: PickJobAbortActionEnum
      description: PickJobAbortActionEnum
    PickJobAbortActionParameter:
      additionalProperties: false
      description: Action to Abort a Pickjob.
      properties:
        name:
          $ref: '#/components/schemas/PickJobAbortActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobAbortActionParameter
      type: object
    PickJobActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/PickJobAbortActionParameter'
        - $ref: '#/components/schemas/PickJobRestartActionParameter'
        - $ref: '#/components/schemas/PickJobResetActionParameter'
        - $ref: '#/components/schemas/PickJobObsoleteActionParameter'
        - $ref: '#/components/schemas/PickJobReplaceAssignedUsersActionParameter'
        - $ref: '#/components/schemas/PickJobPauseActionParameter'
        - $ref: '#/components/schemas/PickJobStartActionParameter'
        - $ref: '#/components/schemas/PickJobSplitLineItemsActionParameter'
        - $ref: '#/components/schemas/PickJobMergeLineItemsActionParameter'
        - $ref: >-
            #/components/schemas/UpdatePickLineItemRecordableAttributesActionParameter
        - $ref: '#/components/schemas/PickJobPickedActionParameter'
        - $ref: '#/components/schemas/ModifyPickLineItemsActionParameter'
        - $ref: '#/components/schemas/PickJobAddTargetTimeActionParameter'
        - $ref: '#/components/schemas/PickJobCancelActionParameter'
        - $ref: '#/components/schemas/PickJobCloseActionParameter'
      title: PickJobActionsParameter
      description: PickJobActionsParameter
    PickJobAddTargetTimeActionEnum:
      enum:
        - ADD_TARGET_TIME
      type: string
      title: PickJobAddTargetTimeActionEnum
      description: PickJobAddTargetTimeActionEnum
    PickJobAddTargetTimeActionParameter:
      additionalProperties: false
      description: >-
        Action to add targetTime to a PickJob that has none. Will fail if
        targetTime is already set
      properties:
        name:
          $ref: '#/components/schemas/PickJobAddTargetTimeActionEnum'
        targetTime:
          description: The target time you want set for the given pickJob.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - targetTime
      title: PickJobAddTargetTimeActionParameter
    PickJobCancelActionEnum:
      enum:
        - CANCEL
      type: string
      title: PickJobCancelActionEnum
      description: PickJobCancelActionEnum
    PickJobCancelActionParameter:
      additionalProperties: false
      description: 'Action to cancel a Pickjob. '
      properties:
        name:
          $ref: '#/components/schemas/PickJobCancelActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobCancelActionParameter
      type: object
    PickJobCloseActionEnum:
      enum:
        - CLOSE
      type: string
      title: PickJobCloseActionEnum
      description: PickJobCloseActionEnum
    PickJobCloseActionParameter:
      additionalProperties: false
      description: >-
        Action to close a PickJob. Directly setting a pickJob to CLOSED will
        skip non zero shortPick actions like rerouting, setting subStatus to
        SHORT_PICKED instead. If none of the pickLineItems have been picked, the
        pickJob will be set to ABORTED instead of CLOSED.
      properties:
        name:
          $ref: '#/components/schemas/PickJobCloseActionEnum'
        version:
          description: Version of the entity to be closed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobCloseActionParameter
      type: object
    PickjobDeliveryInformation:
      allOf:
        - $ref: '#/components/schemas/PickjobDeliveryInformationForCreation'
        - required:
            - channel
      type: object
      title: PickjobDeliveryInformation
      description: PickjobDeliveryInformation
    PickJobDeliveryInformationChannel:
      enum:
        - COLLECT
        - SHIPPING
      type: string
      title: PickJobDeliveryInformationChannel
      description: PickJobDeliveryInformationChannel
    PickjobDeliveryInformationForCreation:
      properties:
        channel:
          $ref: '#/components/schemas/PickJobDeliveryInformationChannel'
        details:
          properties:
            collect:
              properties:
                identifier:
                  description: Includes information about Click & Collect recipient
                  type: string
                paid:
                  default: false
                  description: Indicates if the order is already paid.
                  type: boolean
              type: object
            shipping:
              properties:
                carrierKey:
                  type: string
                carrierProduct:
                  description: >-
                    Desired product of given carrier to choose when ordering a
                    label, this is specific to a carrier
                  example: EXPRESS
                  type: string
                carrierProductCategory:
                  $ref: '#/components/schemas/CarrierProductCategory'
                carrierServices:
                  items:
                    $ref: '#/components/schemas/CarrierServices'
                  type: array
                identifier:
                  description: >-
                    Includes information on how to identify Ship from Store
                    recipient (Name, PIN, Reference number, ...)
                  type: string
                invoiceAddress:
                  $ref: '#/components/schemas/ConsumerAddress'
                postalAddress:
                  $ref: '#/components/schemas/ConsumerAddress'
                recipientaddress:
                  $ref: '#/components/schemas/ConsumerAddress'
                serviceLevel:
                  description: TBD
                  enum:
                    - DELIVERY
                    - SAMEDAY
                  type: string
              type: object
          type: object
        targetTime:
          description: At which time the result is expected.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        targetTimeBaseDate:
          description: The start date for the targetTime calculation.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      type: object
      title: PickjobDeliveryInformationForCreation
      description: PickjobDeliveryInformationForCreation
    PickJobForCreation:
      additionalProperties: false
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the pickjob. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        deliveryinformation:
          $ref: '#/components/schemas/PickjobDeliveryInformationForCreation'
        expectedPickLineItems:
          items:
            $ref: '#/components/schemas/ExpectedPickLineItemForCreation'
          minItems: 0
          type: array
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        operativeProcessRef:
          type: string
        orderDate:
          description: The date this order was created at the supplying system.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        orderRef:
          description: >-
            The id of the order reference. The given ID has to be present in the
            system.
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        pickingTimes:
          $ref: '#/components/schemas/PickJobPickingTimes'
        pickLineItems:
          items:
            $ref: '#/components/schemas/PickLineItemForCreation'
          minItems: 0
          type: array
        preferredPickingMethods:
          description: Preferred way of picking a given pickJob.
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          type: array
        processId:
          description: >-
            Id of the global process related to this entity. For example used
            for starting the GDPR process and others.
          type: string
        routingPlanRef:
          description: Reference to the routingplan which created this pickjob
          type: string
        shortId:
          description: A short identifier that helps assigning a pick job to a customer.
          example: AS12
          type: string
        status:
          $ref: '#/components/schemas/PickJobStatus'
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          minItems: 0
          type: array
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        transfers:
          items:
            $ref: '#/components/schemas/OperativeTransfer'
          minItems: 0
          type: array
        workflowInformation:
          oneOf:
            - $ref: '#/components/schemas/WorkflowInformation'
            - $ref: '#/components/schemas/WorkflowUnavailable'
        tags:
          description: >-
            Tags can only be set when there is no process related with this
            pickJob. Setting processId and tags will lead to an validationError.
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - orderDate
        - facilityRef
        - pickLineItems
      type: object
      xml:
        name: Pickjob
      title: PickJobForCreation
      description: PickJobForCreation
    PickJobLineItemPartialStockLocation:
      allOf:
        - $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForCreation'
      properties:
        picked:
          description: >-
            Quantity of the specific article that was picked from this stock
            location.
          example: 21
          format: int64
          minimum: 0
          type: number
        stockEmptied:
          example: true
          type: boolean
        zoneName:
          type: string
        zoneRef:
          type: string
      required:
        - tenantPartialStockId
        - stockRef
      type: object
      title: PickJobLineItemPartialStockLocation
      description: PickJobLineItemPartialStockLocation
    PickJobLineItemPartialStockLocationForCreation:
      properties:
        available:
          description: Quantity of unreserved items at the stock location.
          example: 21
          format: int64
          minimum: 0
          type: number
        location:
          $ref: '#/components/schemas/Location'
        quantity:
          description: >-
            Quantity of the specific article that should be picked from given
            stock location.
          example: 21
          format: int64
          minimum: 0
          type: number
        ratingScore:
          type: number
        sequenceScore:
          type: number
        stockProperties:
          anyOf:
            - $ref: '#/components/schemas/PickingStockPropertyPreset'
            - $ref: '#/components/schemas/PickingStockProperty'
        stockRef:
          type: string
        tenantPartialStockId:
          type: string
      required:
        - tenantPartialStockId
        - stockRef
      type: object
      title: PickJobLineItemPartialStockLocationForCreation
      description: PickJobLineItemPartialStockLocationForCreation
    PickJobLineItemPartialStockLocationForUpdate:
      properties:
        picked:
          example: 21
          format: int64
          minimum: 0
          type: number
        stockEmptied:
          example: true
          type: boolean
        stockRef:
          type: string
        tenantPartialStockId:
          type: string
      required:
        - tenantPartialStockId
        - picked
      type: object
      title: PickJobLineItemPartialStockLocationForUpdate
      description: PickJobLineItemPartialStockLocationForUpdate
    PickJobMergeLineItemsActionEnum:
      enum:
        - MERGE_LINE_ITEMS_PICK_JOB
      type: string
      title: PickJobMergeLineItemsActionEnum
      description: PickJobMergeLineItemsActionEnum
    PickJobMergeLineItemsActionParameter:
      additionalProperties: false
      properties:
        lineItemIds:
          description: Ids of the line items that should be merged
          items:
            type: string
          type: array
        name:
          $ref: '#/components/schemas/PickJobMergeLineItemsActionEnum'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - lineItemIds
      title: PickJobMergeLineItemsActionParameter
      type: object
      description: PickJobMergeLineItemsActionParameter
    PickJobObsoleteActionEnum:
      enum:
        - OBSOLETE
      type: string
      title: PickJobObsoleteActionEnum
      description: PickJobObsoleteActionEnum
    PickJobObsoleteActionParameter:
      additionalProperties: false
      description: Action to set the status to Obsolete of a Pickjob.
      properties:
        name:
          $ref: '#/components/schemas/PickJobObsoleteActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobObsoleteActionParameter
      type: object
    PickJobOrderBy:
      description: Attribute to order a pickJobs by
      enum:
        - TARGET_TIME_DESC
        - TARGET_TIME_ASC
        - LAST_MODIFIED_DESC
        - LAST_MODIFIED_ASC
        - ORDER_DATE_DESC
        - ORDER_DATE_ASC
        - LAST_MODIFIED_BY_USER_DESC
        - LAST_MODIFIED_BY_USER_ASC
      type: string
      xml:
        name: PickJobOrderBy
      title: PickJobOrderBy
    PickJobPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        pickJobs:
          items:
            $ref: '#/components/schemas/PickJob'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - pickJobs
      title: PickJobPaginatedResult
      type: object
      description: PickJobPaginatedResult
    PickJobPauseActionEnum:
      enum:
        - PAUSE
      type: string
      title: PickJobPauseActionEnum
      description: PickJobPauseActionEnum
    PickJobPauseActionParameter:
      additionalProperties: false
      description: Action to pause a Pickjob.
      properties:
        name:
          $ref: '#/components/schemas/PickJobPauseActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobPauseActionParameter
      type: object
    PickJobPickedActionEnum:
      enum:
        - PICK
      type: string
      title: PickJobPickedActionEnum
      description: PickJobPickedActionEnum
    PickJobPickedActionParameter:
      additionalProperties: false
      description: Action to set the status to Picked of a Pickjob.
      properties:
        lineItems:
          description: 'Pick line items that should be updated '
          items:
            $ref: '#/components/schemas/PickPickJobPickLineItemUpdate'
          maxItems: 100
          minItems: 1
          type: array
        name:
          $ref: '#/components/schemas/PickJobPickedActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - lineItems
      title: PickJobPickedActionParameter
      type: object
    PickJobPickingMethodEnumEnumFilter:
      properties:
        eq:
          description: Search by preferredPickingMethods
          enum:
            - SINGLE_ORDER
            - MULTI_ORDER
            - BATCH_PICKING
            - BATCH
          type: string
        in:
          description: Search by preferredPickingMethods
          items:
            enum:
              - SINGLE_ORDER
              - MULTI_ORDER
              - BATCH_PICKING
              - BATCH
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by preferredPickingMethods
          enum:
            - SINGLE_ORDER
            - MULTI_ORDER
            - BATCH_PICKING
            - BATCH
          type: string
      title: PickJobPickingMethodEnumEnumFilter
      type: object
      description: PickJobPickingMethodEnumEnumFilter
    PickJobPickingMethodEnumEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/PickJobPickingMethodEnumEnumFilter'
          description: Search by preferredPickingMethods
      title: PickJobPickingMethodEnumEnumListFilter
      type: object
      description: PickJobPickingMethodEnumEnumListFilter
    PickJobPickingTimes:
      additionalProperties: false
      properties:
        startLatestAt:
          description: The date this pickJob should be started at last.
          example: 2024-02-03T09:45:51.525Z
          format: date-time
          type: string
      type: object
      title: PickJobPickingTimes
      description: PickJobPickingTimes
    PickjobPickLinePickedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/PickLineItem'
        pickJobRef:
          type: string
      required:
        - payload
        - pickJobRef
      type: object
      title: PickjobPickLinePickedWebHookEvent
      description: PickjobPickLinePickedWebHookEvent
    PickJobReplaceAssignedUsersActionEnum:
      enum:
        - REPLACE_ASSIGNED_USERS
      type: string
      title: PickJobReplaceAssignedUsersActionEnum
      description: PickJobReplaceAssignedUsersActionEnum
    PickJobReplaceAssignedUsersActionParameter:
      additionalProperties: false
      description: Action to replace the assigned users.
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          type: array
        name:
          $ref: '#/components/schemas/PickJobReplaceAssignedUsersActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - assignedUsers
      title: PickJobReplaceAssignedUsersActionParameter
    PickJobResetActionEnum:
      enum:
        - RESET
      type: string
      title: PickJobResetActionEnum
      description: PickJobResetActionEnum
    PickJobResetActionParameter:
      additionalProperties: false
      description: Action to reset a Pickjob.
      properties:
        name:
          $ref: '#/components/schemas/PickJobResetActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobResetActionParameter
      type: object
    PickJobRestartActionEnum:
      enum:
        - RESTART
      type: string
      title: PickJobRestartActionEnum
      description: PickJobRestartActionEnum
    PickJobRestartActionParameter:
      additionalProperties: false
      description: Action to Restart a Pickjob.
      properties:
        name:
          $ref: '#/components/schemas/PickJobRestartActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobRestartActionParameter
      type: object
    PickJobSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/PickJobSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/PickJobSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: PickJobSearchPayload
      type: object
      description: PickJobSearchPayload
    PickJobSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/PickJobSearchQuery'
          maxItems: 500
          type: array
        consumerName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by consumerName
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringEqFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/PickJobSearchQuery'
          maxItems: 500
          type: array
        orderRef:
          allOf:
            - $ref: '#/components/schemas/StringEqFilter'
          description: Search by orderRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        preferredPickingMethods:
          allOf:
            - $ref: '#/components/schemas/PickJobPickingMethodEnumEnumListFilter'
          description: Search by preferredPickingMethods
        status:
          allOf:
            - $ref: '#/components/schemas/PickJobStatusEnumFilter'
          description: Search by status
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantArticleIds:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by tenantArticleIds
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
        transfers:
          allOf:
            - $ref: '#/components/schemas/PickJobTransfersListFilter'
          description: Nested list search by transfers
      title: PickJobSearchQuery
      type: object
      description: PickJobSearchQuery
    PickJobSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
        tenantOrderId:
          enum:
            - ASC
            - DESC
          type: string
      title: PickJobSort
      type: object
      description: PickJobSort
    PickJobSplitLineItemsActionEnum:
      enum:
        - SPLIT_LINE_ITEMS_PICK_JOB
      type: string
      title: PickJobSplitLineItemsActionEnum
      description: PickJobSplitLineItemsActionEnum
    PickJobSplitLineItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickJobSplitLineItemsActionEnum'
        splitLineItemsInfo:
          items:
            $ref: '#/components/schemas/PickJobSplitLineItemsInfo'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - splitLineItemsInfo
      title: PickJobSplitLineItemsActionParameter
      type: object
      description: PickJobSplitLineItemsActionParameter
    PickJobSplitLineItemsInfo:
      additionalProperties: false
      properties:
        lineItemId:
          description: references the id of the pickLineItem of a pickJob
          type: string
        picked:
          description: The amount of articles that were picked for this line item.
          example: 20
          format: int64
          minimum: 0
          type: integer
        quantity:
          description: quantity of the specific item that has been ordered
          example: 21
          minimum: 1
          type: integer
      required:
        - lineItemId
        - quantity
        - picked
      type: object
      title: PickJobSplitLineItemsInfo
      description: PickJobSplitLineItemsInfo
    PickJobStartActionEnum:
      enum:
        - START
      type: string
      title: PickJobStartActionEnum
      description: PickJobStartActionEnum
    PickJobStartActionParameter:
      additionalProperties: false
      description: >-
        Action to start a PickJob by setting it and its line items to
        IN_PROGRESS.
      properties:
        name:
          $ref: '#/components/schemas/PickJobStartActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickJobStartActionParameter
      type: object
    PickJobStatus:
      description: The status of a pickjob.
      enum:
        - ABORTED
        - OPEN
        - IN_PROGRESS
        - CLOSED
        - PICKED
        - REROUTED
        - REJECTED
        - RESTOWED
        - EXPIRED
        - CANCELED
        - OBSOLETE
        - WAITING_FOR_INPUT
        - PAUSED
      type: string
      xml:
        name: PickJobStatus
      title: PickJobStatus
    PickJobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - ABORTED
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - PICKED
            - REROUTED
            - REJECTED
            - RESTOWED
            - EXPIRED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
            - PAUSED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - ABORTED
              - OPEN
              - IN_PROGRESS
              - CLOSED
              - PICKED
              - REROUTED
              - REJECTED
              - RESTOWED
              - EXPIRED
              - CANCELED
              - OBSOLETE
              - WAITING_FOR_INPUT
              - PAUSED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - ABORTED
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - PICKED
            - REROUTED
            - REJECTED
            - RESTOWED
            - EXPIRED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
            - PAUSED
          type: string
      title: PickJobStatusEnumFilter
      type: object
      description: PickJobStatusEnumFilter
    PickJobStatusUnprotected:
      description: >-
        The status of a pickjob. These are the status that are still allowed to
        be used in the deprecated status field of ModifyPickJob actions
      enum:
        - OPEN
        - IN_PROGRESS
        - CLOSED
        - PICKED
        - REROUTED
        - REJECTED
        - RESTOWED
        - EXPIRED
        - PAUSED
        - WAITING_FOR_INPUT
      type: string
      xml:
        name: PickJobStatusUnprotected
      title: PickJobStatusUnprotected
    PickJobSubStatus:
      description: >-
        The reason for the current status, providing type-safe context beyond
        the status field.
      enum:
        - SHORT_PICKED
        - ZERO_PICKED
        - WAITING_FOR_RELEASE_TIME
        - ORDER_MODIFIED
        - PROCESS_REROUTE
        - MANUAL_REROUTE
        - SHORT_PICK_REROUTE
        - TIME_TRIGGERED
        - STOCK_ZEROED
        - PICK_JOB_ABORTED
        - RECALCULATION
      type: string
      xml:
        name: PickJobSubStatus
      title: PickJobSubStatus
    PickJobTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        lineItemScanningConfiguration:
          $ref: '#/components/schemas/TagScanningConfiguration'
        lineItemStickerConfiguration:
          $ref: '#/components/schemas/StickerConfiguration'
        offeredDocumentsByDefault:
          description: >-
            This configuration is a fallback and applies only if none of the
            entries in offeredDocumentsPerTag can be applied
          items:
            $ref: '#/components/schemas/OfferedDocument'
          type: array
        offeredDocumentsPerTag:
          description: >-
            All entries with a match in their matchingValues will be combined
            when determining what documents belong to an entity
          items:
            $ref: '#/components/schemas/OfferedDocumentPerTag'
          type: array
        preferredPickingMethodsConfiguration:
          $ref: '#/components/schemas/PreferredPickingMethodsConfiguration'
        stickerConfiguration:
          $ref: '#/components/schemas/StickerConfiguration'
      required:
        - offeredDocumentsPerTag
        - offeredDocumentsByDefault
      title: PickJobTagConfiguration
      description: PickJobTagConfiguration
    PickJobTransfersFilter:
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/StringEqFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: PickJobTransfersFilter
      type: object
      description: PickJobTransfersFilter
    PickJobTransfersListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/PickJobTransfersFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: PickJobTransfersListFilter
      type: object
      description: PickJobTransfersListFilter
    PickjobWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/PickJob'
      required:
        - payload
      type: object
      title: PickjobWebHookEvent
      description: PickjobWebHookEvent
    PickLineItem:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - properties:
            allowedSubstitutes:
              items:
                $ref: '#/components/schemas/Substitute'
              type: array
            article:
              $ref: '#/components/schemas/PickLineItemArticle'
            customAttributes:
              description: >-
                Attributes that can be added to the pick line. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the information carried here.
              type: object
            globalLineItemId:
              description: >-
                This id is used to identify if this line item is related to the
                line item of other operational entities.
              example: a81f818e-2405-4570-8cde-b0c80fd3de31
              type: string
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            measurementValidation:
              $ref: '#/components/schemas/MeasurementValidation'
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            partialStockLocations:
              description: >-
                Indicates where the items to pick could be found and from where
                the picking should be started.
              items:
                $ref: '#/components/schemas/PickJobLineItemPartialStockLocation'
            picked:
              description: The amount of articles that were picked for this pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            pickedAt:
              description: Date when the line has been picked.
              example: 2024-02-03T08:45:51.525Z
              format: date-time
              type: string
            pickJobLineItemRef:
              description: used for line items in pick runs to be split up correctly again
              example: '12345'
              type: string
            quantity:
              description: quantity of the specific article that has been ordered
              example: 21
              format: int64
              minimum: 1
              type: integer
            recordableAttributes:
              items:
                $ref: '#/components/schemas/RecordableAttribute'
              nullable: true
              type: array
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
            scannedCodes:
              items:
                $ref: '#/components/schemas/PickLineItemScannedCode'
              minimum: 0
              type: array
            scanningRule:
              $ref: '#/components/schemas/ScanningRuleConfiguration'
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Deprecated: Use scanningRules instead. This value
                indicates which scanning rule should be applied for this pick
                line. Only generated on demand on separate call, no persistence.
            scanningRules:
              $ref: '#/components/schemas/PickLineItemScanningRules'
            secondaryMeasurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            secondaryPicked:
              description: >-
                The secondary amount of articles that were picked for this
                pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            secondaryQuantity:
              description: quantity of the specific article that has been ordered
              example: 21
              format: int64
              minimum: 0
              type: integer
            shortPickReason:
              $ref: '#/components/schemas/PickLineShortPickReason'
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            stockEmptied:
              example: true
              type: boolean
            substituteLineItems:
              description: >-
                This part of the API is in Beta status. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />
              items:
                $ref: '#/components/schemas/SubstituteLineItem'
              type: array
              x-badges:
                - color: orange
                  label: BETA
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
          required:
            - id
            - picked
            - status
            - quantity
            - article
          type: object
      title: PickLineItem
      description: PickLineItem
    PickLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/LineItemArticle'
      properties:
        prices:
          deprecated: true
          items:
            $ref: '#/components/schemas/ArticlePrice'
          type: array
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
      type: object
      xml:
        name: PickLineItemArticle
      title: PickLineItemArticle
      description: PickLineItemArticle
    PickLineItemForCreation:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItemForCreation'
      properties:
        allowedSubstitutes:
          items:
            $ref: '#/components/schemas/Substitute'
          type: array
        article:
          $ref: '#/components/schemas/PickLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        measurementValidation:
          $ref: '#/components/schemas/MeasurementValidation'
        partialStockLocations:
          description: >-
            Indicates where the items to pick could be found and from where the
            picking should be started.
          items:
            $ref: >-
              #/components/schemas/PickJobLineItemPartialStockLocationForCreation
          type: array
        quantity:
          description: Quantity of the specific article that has been ordered.
          example: 21
          format: int64
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        secondaryQuantity:
          description: Quantity of the specific article that has been ordered.
          example: 21
          format: int64
          minimum: 0
          type: integer
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - quantity
        - article
      type: object
      title: PickLineItemForCreation
      description: PickLineItemForCreation
    PickLineItemScannedCode:
      properties:
        code:
          description: scannable code i.e. barcode
          example: 1245678
          type: string
        quantity:
          description: scanned quantity
          example: 7
          format: int64
          minimum: 0
          type: integer
      required:
        - code
        - quantity
      type: object
      title: PickLineItemScannedCode
      description: PickLineItemScannedCode
    PickLineItemScanningRules:
      additionalProperties: false
      properties:
        scanningMode:
          $ref: '#/components/schemas/PickingScanningConfigurationEnum'
        scanningType:
          items:
            $ref: '#/components/schemas/ScanningRuleValue'
          type: array
      title: PickLineItemScanningRules
      description: PickLineItemScanningRules
    PickLineItemStatus:
      description: >-
        A pickjob line item initially has the status OPEN and picking can start.
        When a line item is opened within the picking app, the item changes its
        status to IN_PROGRESS. When the commissioning is finished the state is
        CLOSED
      enum:
        - OPEN
        - IN_PROGRESS
        - CLOSED
      type: string
      xml:
        name: PickLineItemStatus
      title: PickLineItemStatus
    PickLineItemUpdate:
      additionalProperties: false
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the pick ine item. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          nullable: true
          type: object
        id:
          description: >-
            The id of this lineItem. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: climk4dcQFiPdA5ULuhS
          type: string
        partialStockLocations:
          items:
            $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForUpdate'
          maxItems: 50
          type: array
        picked:
          description: The amount of articles that were picked for this pickline.
          example: 20
          format: int64
          minimum: 0
          type: integer
        pickedAt:
          description: Date when the line has been picked.
          example: 2024-02-03T08:45:51.525Z
          format: date-time
          type: string
        scannedCodes:
          description: Scanned Codes of the given picked line item
          items:
            $ref: '#/components/schemas/PickLineItemScannedCode'
          maxItems: 50
          minItems: 0
          type: array
        secondaryPicked:
          type: integer
        shortPickReason:
          properties:
            reasonLocalized:
              $ref: '#/components/schemas/LocaleString'
        status:
          $ref: '#/components/schemas/PickLineItemStatus'
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 50
          type: array
        stockEmptied:
          example: true
          type: boolean
        substituteLineItems:
          description: >-
            This part of the API is in Beta status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          items:
            $ref: '#/components/schemas/SubstituteLineItemForUpsert'
          maxItems: 50
          type: array
          x-badges:
            - color: orange
              label: BETA
      required:
        - id
      type: object
      title: PickLineItemUpdate
      description: PickLineItemUpdate
    PickLineShortPickReason:
      additionalProperties: false
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
        reason:
          description: translated reasonLocalized according to the given locale
          type: string
      required:
        - reasonLocalized
      title: PickLineShortPickReason
      description: PickLineShortPickReason
    PickPickJobPickLineItemUpdate:
      additionalProperties: false
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the pick ine item. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          nullable: true
          type: object
        id:
          description: >-
            The id of this lineItem. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: climk4dcQFiPdA5ULuhS
          type: string
        partialStockLocations:
          items:
            $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForUpdate'
          maxItems: 50
          type: array
        picked:
          description: The amount of articles that were picked for this pickline.
          example: 20
          format: int64
          minimum: 0
          type: integer
        pickedAt:
          description: >-
            Date when the line has been picked. example:
            '2024-02-03T08:45:51.525Z' format: date-time type: string
        scannedCodes:
          description: Scanned Codes of the given picked line item
          items:
            $ref: '#/components/schemas/PickLineItemScannedCode'
          maxItems: 50
          minItems: 0
          type: array
        secondaryPicked:
          type: integer
        shortPickReason:
          properties:
            reasonLocalized:
              $ref: '#/components/schemas/LocaleString'
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 50
          type: array
        stockEmptied:
          example: true
          type: boolean
        substituteLineItems:
          description: >-
            This part of the API is in Beta status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          items:
            $ref: '#/components/schemas/SubstituteLineItemForUpsert'
          maxItems: 50
          type: array
          x-badges:
            - color: orange
              label: BETA
      required:
        - id
      type: object
      title: PickPickJobPickLineItemUpdate
      description: PickPickJobPickLineItemUpdate
    PickRun:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            editor:
              $ref: '#/components/schemas/Editor'
            facilityRef:
              type: string
            id:
              type: string
            pickJobRefs:
              items:
                type: string
              type: array
            pickLineItems:
              items:
                $ref: '#/components/schemas/PickRunLineItem'
              type: array
            pickRunType:
              $ref: '#/components/schemas/PickRunType'
            status:
              $ref: '#/components/schemas/PickRunStatus'
      required:
        - pickLineItems
        - pickJobRefs
        - facilityRef
        - status
        - id
      type: object
      title: PickRun
      description: PickRun
    PickRunActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/PickRunStartActionParameter'
        - $ref: '#/components/schemas/PickRunFinishActionParameter'
        - $ref: '#/components/schemas/PickRunCancelActionParameter'
        - $ref: '#/components/schemas/PickRunPauseActionParameter'
        - $ref: '#/components/schemas/PickRunResumeActionParameter'
        - $ref: '#/components/schemas/PickRunRemovePickJobActionParameter'
        - $ref: '#/components/schemas/PickRunSplitLineItemsActionParameter'
        - $ref: '#/components/schemas/TakeOverPickRunActionParameter'
      title: PickRunActionsParameter
      description: PickRunActionsParameter
    PickRunCancelActionEnum:
      enum:
        - CANCEL
      type: string
      title: PickRunCancelActionEnum
      description: PickRunCancelActionEnum
    PickRunCancelActionParameter:
      additionalProperties: false
      description: Action to cancel a PickRun.
      properties:
        name:
          $ref: '#/components/schemas/PickRunCancelActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickRunCancelActionParameter
      type: object
    PickRunFinishActionEnum:
      enum:
        - FINISH
      type: string
      title: PickRunFinishActionEnum
      description: PickRunFinishActionEnum
    PickRunFinishActionParameter:
      additionalProperties: false
      description: Action to finish a PickRun.
      properties:
        name:
          $ref: '#/components/schemas/PickRunFinishActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickRunFinishActionParameter
      type: object
    PickRunForCreation:
      properties:
        facilityRef:
          type: string
        pickJobRefs:
          items:
            type: string
          minItems: 1
          type: array
        pickRunType:
          $ref: '#/components/schemas/PickRunType'
        status:
          $ref: '#/components/schemas/PickRunStatus'
      required:
        - pickJobRefs
        - facilityRef
      type: object
      title: PickRunForCreation
      description: PickRunForCreation
    PickRunLineItem:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - properties:
            allowedSubstitutes:
              items:
                $ref: '#/components/schemas/Substitute'
              type: array
            article:
              $ref: '#/components/schemas/PickLineItemArticle'
            customAttributes:
              description: >-
                Attributes that can be added to the pick line. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the information carried here.
              type: object
            globalLineItemIds:
              items:
                description: Global line item ids that refer to this line item
                type: string
              type: array
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            measurementValidation:
              $ref: '#/components/schemas/MeasurementValidation'
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            partialStockLocations:
              description: >-
                Indicates where the items to pick could be found and from where
                the picking should be started.
              items:
                $ref: '#/components/schemas/PickJobLineItemPartialStockLocation'
            picked:
              description: The amount of articles that were picked for this pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            pickedAt:
              description: Date when the line has been picked.
              example: 2024-02-03T08:45:51.525Z
              format: date-time
              type: string
            pickJobLineItemRef:
              description: used for line items in pick runs to be split up correctly again
              example: '12345'
              type: string
            pickJobRef:
              type: string
            quantity:
              description: quantity of the specific article that has been ordered
              example: 21
              format: int64
              minimum: 1
              type: integer
            recordableAttributes:
              items:
                $ref: '#/components/schemas/RecordableAttribute'
              nullable: true
              type: array
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
            scannedCodes:
              items:
                $ref: '#/components/schemas/PickLineItemScannedCode'
              minimum: 0
              type: array
            scanningRule:
              $ref: '#/components/schemas/ScanningRuleConfiguration'
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Deprecated: Use scanningRules instead. This value
                indicates which scanning rule should be applied for this pick
                line. Only generated on demand on separate call, no persistence.
            scanningRules:
              $ref: '#/components/schemas/PickLineItemScanningRules'
            secondaryMeasurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            secondaryPicked:
              description: >-
                The secondary amount of articles that were picked for this
                pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            secondaryQuantity:
              description: quantity of the specific article that has been ordered
              example: 21
              format: int64
              minimum: 0
              type: integer
            shortPickReason:
              $ref: '#/components/schemas/PickLineShortPickReason'
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            stockEmptied:
              example: true
              type: boolean
            substituteLineItems:
              description: >-
                This part of the API is in Beta status. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />
              items:
                $ref: '#/components/schemas/SubstituteLineItem'
              type: array
              x-badges:
                - color: orange
                  label: BETA
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
          required:
            - id
            - picked
            - status
            - quantity
            - article
          type: object
      title: PickRunLineItem
      description: PickRunLineItem
    PickRunLineItems:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - properties:
            allowedSubstitutes:
              items:
                $ref: '#/components/schemas/Substitute'
              type: array
            article:
              $ref: '#/components/schemas/PickLineItemArticle'
            customAttributes:
              description: >-
                Attributes that can be added to the pick line. These attributes
                cannot be used within fulfillment processes, but it could be
                useful to have the information carried here.
              type: object
            globalLineItemIds:
              items:
                description: Global line item ids that refer to this line item
                type: string
              type: array
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            measurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            measurementValidation:
              $ref: '#/components/schemas/MeasurementValidation'
            originId:
              description: >-
                The id of the line item this line item was originated from,
                before any split has happened. This can be used to restore the
                ‘pre-split’ status.
              example: df671041-10dd-4600-a2ff-e9ffe2556bba
              nullable: true
              type: string
            partialStockLocations:
              description: >-
                Indicates where the items to pick could be found and from where
                the picking should be started.
              items:
                $ref: '#/components/schemas/PickJobLineItemPartialStockLocation'
            picked:
              description: The amount of articles that were picked for this pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            pickedAt:
              description: Date when the line has been picked.
              example: 2024-02-03T08:45:51.525Z
              format: date-time
              type: string
            pickJobLineItemRef:
              description: used for line items in pick runs to be split up correctly again
              example: '12345'
              type: string
            pickJobRef:
              type: string
            quantity:
              description: quantity of the specific article that has been ordered
              example: 21
              format: int64
              minimum: 1
              type: integer
            recordableAttributes:
              items:
                $ref: '#/components/schemas/RecordableAttribute'
              nullable: true
              type: array
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
            scannedCodes:
              items:
                $ref: '#/components/schemas/PickLineItemScannedCode'
              minimum: 0
              type: array
            scanningRule:
              $ref: '#/components/schemas/ScanningRuleConfiguration'
              deprecated: true
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />Deprecated: Use scanningRules instead. This value
                indicates which scanning rule should be applied for this pick
                line. Only generated on demand on separate call, no persistence.
            scanningRules:
              $ref: '#/components/schemas/PickLineItemScanningRules'
            secondaryMeasurementUnitKey:
              description: Identifier for items unit of measurement.
              example: liter
              type: string
            secondaryPicked:
              description: >-
                The secondary amount of articles that were picked for this
                pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            secondaryQuantity:
              description: quantity of the specific article that has been ordered
              example: 21
              format: int64
              minimum: 0
              type: integer
            shortPickReason:
              $ref: '#/components/schemas/PickLineShortPickReason'
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            stockEmptied:
              example: true
              type: boolean
            substituteLineItems:
              description: >-
                This part of the API is in Beta status. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />
              items:
                $ref: '#/components/schemas/SubstituteLineItem'
              type: array
              x-badges:
                - color: orange
                  label: BETA
            tags:
              items:
                $ref: '#/components/schemas/TagReference'
              type: array
          required:
            - id
            - picked
            - status
            - quantity
            - article
          type: object
      title: PickRunLineItems
      description: PickRunLineItems
    PickRunPatchAction:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyPickRunLineItem'
              - $ref: '#/components/schemas/StartPickRun'
              - $ref: '#/components/schemas/CancelPickRun'
              - $ref: '#/components/schemas/FinishPickRun'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: PickRunPatchAction
      title: PickRunPatchAction
      description: PickRunPatchAction
    PickRunPauseActionEnum:
      enum:
        - PAUSE
      type: string
      title: PickRunPauseActionEnum
      description: PickRunPauseActionEnum
    PickRunPauseActionParameter:
      additionalProperties: false
      description: Action to pause a PickRun.
      properties:
        name:
          $ref: '#/components/schemas/PickRunPauseActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickRunPauseActionParameter
      type: object
    PickRunPickJobsPatchAction:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/RemovePickJobFromPickRun'
          maxItems: 1
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: PickRunPickJobsPatchAction
      title: PickRunPickJobsPatchAction
      description: PickRunPickJobsPatchAction
    PickRunRemovePickJobActionEnum:
      enum:
        - REMOVE_PICK_JOB
      type: string
      title: PickRunRemovePickJobActionEnum
      description: PickRunRemovePickJobActionEnum
    PickRunRemovePickJobActionParameter:
      additionalProperties: false
      description: Action to Remove a Pickjob from a PickRun.
      properties:
        name:
          $ref: '#/components/schemas/PickRunRemovePickJobActionEnum'
        payload:
          additionalProperties: false
          properties:
            pickJobId:
              example: 4baaa052-7286-4dc2-937f-6e703ece25ac
              type: string
          required:
            - pickJobId
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - payload
      title: PickRunRemovePickJobActionParameter
      type: object
    PickRunResumeActionEnum:
      enum:
        - RESUME
      type: string
      title: PickRunResumeActionEnum
      description: PickRunResumeActionEnum
    PickRunResumeActionParameter:
      additionalProperties: false
      description: Action to resume a PickRun.
      properties:
        name:
          $ref: '#/components/schemas/PickRunResumeActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickRunResumeActionParameter
      type: object
    PickRunSplitLineItemsActionEnum:
      enum:
        - SPLIT_LINES_PICK_RUN
      type: string
      title: PickRunSplitLineItemsActionEnum
      description: PickRunSplitLineItemsActionEnum
    PickRunSplitLineItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickRunSplitLineItemsActionEnum'
        splitLineItemsInfo:
          items:
            $ref: '#/components/schemas/PickRunSplitLineItemsInfo'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - splitLineItemsInfo
      title: PickRunSplitLineItemsActionParameter
      type: object
      description: PickRunSplitLineItemsActionParameter
    PickRunSplitLineItemsInfo:
      additionalProperties: false
      properties:
        lineItemId:
          description: references the id of the pickLineItem of a pickRun
          type: string
        picked:
          description: The amount of articles that were picked for this line item.
          example: 20
          format: int64
          minimum: 0
          type: integer
        quantity:
          description: quantity of the specific item that has been ordered
          example: 21
          minimum: 1
          type: integer
      required:
        - lineItemId
        - quantity
        - picked
      type: object
      title: PickRunSplitLineItemsInfo
      description: PickRunSplitLineItemsInfo
    PickRunStartActionEnum:
      enum:
        - START
      type: string
      title: PickRunStartActionEnum
      description: PickRunStartActionEnum
    PickRunStartActionParameter:
      additionalProperties: false
      description: Action to start a PickRun.
      properties:
        name:
          $ref: '#/components/schemas/PickRunStartActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: PickRunStartActionParameter
      type: object
    PickRunStatus:
      description: The state of the PickRun
      enum:
        - OPEN
        - IN_PROGRESS
        - CLOSED
        - PAUSED
        - CANCELED
        - OBSOLETE
      type: string
      title: PickRunStatus
    PickRunType:
      default: batchPick
      description: >-
        Deprecated: batchPick, use batch instead Deprecated: multiOrderPick, use
        multiOrder instead
      enum:
        - multiOrderPick
        - multiOrder
        - batchPick
        - batch
      type: string
      title: PickRunType
    PostalCodeValidation:
      properties:
        country:
          description: Country in Format [A-Z]{2}
          example: DE
          type: string
        postalCode:
          description: Postal code for validation
          example: '50667'
          type: string
      required:
        - country
        - postalCode
      type: object
      xml:
        name: PostalCodeValidation
      title: PostalCodeValidation
      description: PostalCodeValidation
    PostNlCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: PostNlCarrierConfiguration
      type: object
      description: PostNlCarrierConfiguration
    PreconfiguredGuardCondition:
      properties:
        kind:
          description: 'Discriminator: built-in guard.'
          enum:
            - PRECONFIGURED
          type: string
        preconfigured:
          description: Which built-in guard to run
          enum:
            - ORDER_GATE
          type: string
      required:
        - kind
        - preconfigured
      title: PreconfiguredGuardCondition
      type: object
      description: PreconfiguredGuardCondition
    PreferredCarrier:
      description: Keys of the preferred carriers to handle out the order
      type: string
      title: PreferredCarrier
    PreferredCarrierWithProduct:
      additionalProperties: false
      properties:
        carrierKey:
          example: DPD
          type: string
        carrierProduct:
          example: WORLDWIDE
          type: string
        carrierServices:
          items:
            $ref: '#/components/schemas/CarrierServices'
          maxItems: 500
          type: array
      required:
        - carrierKey
      type: object
      title: PreferredCarrierWithProduct
      description: PreferredCarrierWithProduct
    PreferredPickingMethodsConfiguration:
      properties:
        PreferredPickingMethodsPerTag:
          items:
            $ref: '#/components/schemas/PreferredPickingMethodsPerTag'
          type: array
      title: PreferredPickingMethodsConfiguration
      description: PreferredPickingMethodsConfiguration
    PreferredPickingMethodsPerTag:
      additionalProperties: false
      properties:
        matchingValues:
          items:
            type: string
          minItems: 1
          type: array
        pickingMethods:
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          minItems: 1
          type: array
        tagRef:
          type: string
      required:
        - tagRef
        - pickingMethods
        - matchingValues
      title: PreferredPickingMethodsPerTag
      description: PreferredPickingMethodsPerTag
    PreselectedFacility:
      anyOf:
        - required:
            - facilityRef
        - required:
            - tenantFacilityId
      properties:
        facilityRef:
          description: Reference to the facility which is supposed to fulfill the order.
          type: string
        tenantFacilityId:
          description: Reference to the facility which is supposed to fulfill the order.
          type: string
      type: object
      title: PreselectedFacility
      description: PreselectedFacility
    PreviousModuleContainerInfo:
      description: >-
        This object contains information about the container from which this
        container was created from.
      properties:
        containerRef:
          description: The id of the previous container
          example: 019df7f0-0507-7002-a9ef-6285caa2e785
          type: string
        type:
          $ref: '#/components/schemas/PreviousModuleContainerInfoTypeEnum'
      required:
        - containerRef
        - type
      type: object
      title: PreviousModuleContainerInfo
    PreviousModuleContainerInfoTypeEnum:
      enum:
        - LOAD_UNIT
        - SERVICE_CONTAINER
        - PACKING_TARGET_CONTAINER
      title: PreviousModuleContainerInfoTypeEnum
      description: PreviousModuleContainerInfoTypeEnum
    PriceRange:
      properties:
        currency:
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          type: string
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          format: int32
          minimum: 0
          type: integer
        from:
          description: >-
            Lowest total parcel value that this carrier will be selected for.
            Value is configured in the smallest subunit, e.g. cents.
          example: 1299
          minimum: 0
          type: number
        to:
          description: >-
            Highest total parcel value that this carrier will be selected for.
            Value is configured in the smallest subunit, e.g. cents.
          example: 25000
          minimum: 1
          type: number
      required:
        - from
        - to
        - currency
        - decimalPlaces
      title: PriceRange
      type: object
      description: PriceRange
    PrintableDocument:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the document. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        documentCategory:
          $ref: '#/components/schemas/DocumentCategory'
        documentType:
          $ref: '#/components/schemas/DocumentType'
        id:
          type: string
        name:
          type: string
        operations:
          description: Offered operations for this document
          items:
            $ref: '#/components/schemas/DocumentOperations'
          type: array
        path:
          type: string
        priority:
          minimum: 0
          type: number
        status:
          $ref: '#/components/schemas/DocumentStatus'
      required:
        - documentType
        - id
        - status
        - documentCategory
      type: object
      title: PrintableDocument
      description: PrintableDocument
    PrintableDocumentForUpdate:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        operations:
          items:
            enum:
              - PRINT
              - VIEW
            type: string
          maxItems: 10
          minItems: 1
          type: array
        priority:
          type: number
        status:
          enum:
            - AVAILABLE
            - LOADING
            - REQUESTABLE
            - CANCELED
            - WAITING_FOR_INPUT
          type: string
        version:
          type: number
      required:
        - version
      title: PrintableDocumentForUpdate
      type: object
      description: PrintableDocumentForUpdate
    PrioritizationRule:
      description: >-
        You can select a default Prioritization Rule from the catalog. When you
        decide to select 'CUSTOM' you must also provide a vmExpression to match
        the type CustomPrioritizationRule.
      properties:
        active:
          type: boolean
        id:
          description: >-
            This value identifies this very instance of the prioritization rule.
            It is set autmatically by the server when the configuration is
            updated.
          example: 9156fafb-d0b4-4f99-815e-5f231cb50fae
          type: string
        implementation:
          $ref: '#/components/schemas/PrioritizationRuleImplementation'
        name:
          type: string
      required:
        - active
        - name
        - implementation
      type: object
      title: PrioritizationRule
    PrioritizationRuleImplementation:
      enum:
        - CUSTOM
      type: string
      xml:
        name: PrioritizationRuleImplementation
      title: PrioritizationRuleImplementation
      description: PrioritizationRuleImplementation
    PriorityRatingResult:
      properties:
        id:
          type: string
        matchesPriorityMinimum:
          type: boolean
        name:
          type: string
        routingStrategyNodeId:
          type: string
        type:
          $ref: '#/components/schemas/RatingResultType'
      required:
        - id
        - type
        - routingStrategyNodeId
        - matchesPriorityMinimum
      title: PriorityRatingResult
      description: PriorityRatingResult
    Process:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        carrierManagementStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusDetail'
          description: >-
            Carrier management domain status with aggregated sub-statuses from
            modules.
        deletionDate:
          description: >-
            The date that defines when the entities will be or have been
            deleted.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        documentRefs:
          description: References to documents that are attached to this process.
          items:
            type: string
          type: array
        domainStatuses:
          additionalProperties:
            $ref: '#/components/schemas/DomainStatus'
          deprecated: true
          description: >-
            Deprecated. Use moduleStatuses instead. Overview of the different
            domain adherent status of the process.
          type: object
        domainStatusHistory:
          deprecated: true
          description: >-
            Deprecated. Use moduleEntityStatusesHistory instead. History of
            process status changes caused by changes on the related domains.
          items:
            $ref: '#/components/schemas/DomainStatusHistoryItem'
          type: array
        domsStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
          deprecated: true
          description: >-
            Deprecated. Use domsStatuses instead. Overall DOMS status of the
            process.
        domsStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusDetail'
          description: DOMS domain status with aggregated sub-statuses from modules.
        externalActionRefs:
          description: >-
            References to the external actions connected to this process (if
            any).
          items:
            type: string
          type: array
        facilityRefs:
          description: References of the Facilities connected to this process (if any).
          items:
            type: string
          type: array
        flatRefs:
          description: >-
            This field references all IDs of any entity connected to this
            process.
          items:
            type: string
          type: array
        gdprCleanupDate:
          description: >-
            The date that defines when the entities will be or have been
            anonymized.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        handoverJobRefs:
          description: References to Handoverjobs connected to this process (if present).
          items:
            type: string
          type: array
        id:
          description: ID of this process
          type: string
        inventoryStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
          deprecated: true
          description: >-
            Deprecated. Use inventoryStatuses instead. Overall inventory status
            of the process.
        inventoryStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusDetail'
          description: Inventory domain status with aggregated sub-statuses from modules.
        isAnonymized:
          description: Indicates if the entities have been anonymized.
          type: boolean
        itemReturnJobsRef:
          description: >-
            References to the Item Return Job connected to this process (if
            present).
          items:
            type: string
          type: array
        lastDomainEntityStatuses:
          deprecated: true
          description: >-
            Deprecated. Use lastModuleEntityStatuses instead. The last domain
            statuses of each domain.
          items:
            $ref: '#/components/schemas/LastDomainEntityStatusItem'
          type: array
        lastModuleEntityStatuses:
          description: The last status of each module entity.
          items:
            $ref: '#/components/schemas/LastModuleEntityStatusItem'
          type: array
        moduleEntityStatusesHistory:
          description: History of module entity status changes.
          items:
            $ref: '#/components/schemas/ModuleEntityStatusHistoryItem'
          type: array
        moduleStatuses:
          description: Status of each module involved in this process.
          items:
            $ref: '#/components/schemas/ModuleStatusItem'
          type: array
        operativeStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
          deprecated: true
          description: >-
            Deprecated. Use operativeStatuses instead. Overall operative status
            of the process.
        operativeStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusDetail'
          description: Operative domain status with aggregated sub-statuses from modules.
        orderRef:
          description: References to the Order connected to this process (if present).
          type: string
        packJobRefs:
          description: References of the Packjobs connected to this process (if present).
          items:
            type: string
          type: array
        pickJobRefs:
          description: References to the Pickjobs connected to this process (if present).
          items:
            type: string
          type: array
        returnRefs:
          deprecated: true
          description: >-
            Deprecated. Use itemReturnJobRefs instead. References to the Returns
            connected to this process (if present).
          items:
            type: string
          type: array
        returnStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatus'
          default: NOT_AVAILABLE
          deprecated: true
          description: >-
            Deprecated. Use returnStatuses instead. Overall return status of the
            process.
        returnStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusDetail'
          description: Return domain status with aggregated sub-statuses from modules.
        routingPlanRefs:
          description: >-
            References the RoutingPlans that were used during this process (if
            present).
          items:
            type: string
          type: array
        serviceJobRefs:
          description: >-
            References to the Service Jobs connected to this process (if
            present).
          items:
            type: string
          type: array
        shipmentRefs:
          description: References to the Shipments connected to this process (if present).
          items:
            type: string
          type: array
        status:
          allOf:
            - $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
          deprecated: true
          description: >-
            Deprecated. Use statuses.status instead. Overall status of the
            process.
        statuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusDetail'
          description: Aggregated process status with sub-statuses from all domains.
        tenantOrderId:
          description: The tenantOrderId referencing this process.
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - gdprCleanupDate
        - id
      type: object
      title: Process
      description: Process
    ProcessActionsParameter:
      oneOf:
        - $ref: '#/components/schemas/AddTagsToProcessActionParameter'
        - $ref: '#/components/schemas/AssignFacilityToProcessActionParameter'
        - $ref: '#/components/schemas/UpdateGdprCleanupDateActionParameter'
        - $ref: '#/components/schemas/UpdateProcessDeletionDateActionParameter'
      title: ProcessActionsParameter
      description: ProcessActionsParameter
    ProcessAddressSort:
      properties:
        country:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessAddressSort
      type: object
      description: ProcessAddressSort
    ProcessBrandSort:
      properties:
        name:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessBrandSort
      type: object
      description: ProcessBrandSort
    ProcessCarrierSort:
      properties:
        name:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessCarrierSort
      type: object
      description: ProcessCarrierSort
    ProcessConsumerAddressSort:
      properties:
        country:
          enum:
            - ASC
            - DESC
          type: string
        postalCode:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessConsumerAddressSort
      type: object
      description: ProcessConsumerAddressSort
    ProcessDomainStatusesDomainStatusEnumFilter:
      properties:
        eq:
          description: Search by order
          enum:
            - PENDING
            - CREATED
            - IN_PROGRESS
            - STUCK
            - FINISHED
            - CANCELED
            - OBSOLETE
          type: string
        in:
          description: Search by order
          items:
            enum:
              - PENDING
              - CREATED
              - IN_PROGRESS
              - STUCK
              - FINISHED
              - CANCELED
              - OBSOLETE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by order
          enum:
            - PENDING
            - CREATED
            - IN_PROGRESS
            - STUCK
            - FINISHED
            - CANCELED
            - OBSOLETE
          type: string
      title: ProcessDomainStatusesDomainStatusEnumFilter
      type: object
      description: ProcessDomainStatusesDomainStatusEnumFilter
    ProcessDomainStatusesDomainStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ProcessDomainStatusesDomainStatusEnumFilter'
          description: Search by order
      title: ProcessDomainStatusesDomainStatusEnumListFilter
      type: object
      description: ProcessDomainStatusesDomainStatusEnumListFilter
    ProcessDomainStatusesFilter:
      properties:
        handover:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by handover
        order:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by order
        packing:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by packing
        picking:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by picking
        return:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by return
        routing:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by routing
        service:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by service
        shipping:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessDomainStatusesDomainStatusEnumListFilter
          description: Search by shipping
      title: ProcessDomainStatusesFilter
      type: object
      description: ProcessDomainStatusesFilter
    Processes:
      properties:
        processes:
          items:
            $ref: '#/components/schemas/Process'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: Processes
      description: Processes
    ProcessFacilitySort:
      properties:
        address:
          $ref: '#/components/schemas/ProcessAddressSort'
        name:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessFacilitySort
      type: object
      description: ProcessFacilitySort
    ProcessHistoryDomainType:
      description: The domain type of the process history entry
      enum:
        - ORDER
        - ORDER_MODIFICATION
        - PICKJOB
        - PACKJOB
        - SERVICEJOB
        - PARCEL
        - HANDOVER
        - ROUTING_PLAN
        - EXTERNAL_ACTION
        - SHIPMENT
        - ITEM_RETURN
      type: string
      title: ProcessHistoryDomainType
    ProcessHistoryEventType:
      description: Event types for process history
      enum:
        - ORDER_CREATED
        - LOCKED_ORDER_CREATED
        - DELIVERY_PROMISE_CREATED
        - ORDER_CANCELLED
        - ORDER_FORCE_CANCELLED
        - ORDER_UNLOCKED
        - ORDER_CREATED_FROM_PROMISE
        - ORDER_MANUAL_REROUTE
        - UNROUTABLE_ITEMS_REROUTE
        - REROUTE_FAILED
        - ORDER_MANUAL_FACILITY_ASSIGNMENT
        - ORDER_TIME_TRIGGERED_REROUTE
        - ORDER_HAS_UNROUTABLE_ITEMS
        - ORDER_INACTIVITY_TIME_TRIGGERED_REROUTE
        - TASK_MANUAL_REROUTE
        - ORDER_MODIFICATION_REROUTE
        - PICKING_DONE_INCOMPLETE_REROUTE
        - CONSUMER_ADDRESS_CHANGED
        - ORDER_ITEM_AMOUNT_CHANGED
        - ORDER_ITEM_DELETED
        - ORDER_ITEM_ADDED
        - ORDER_PREFERRED_DATE_MODIFIED
        - OPERATIVE_TASK_CREATED
        - PICKING_IN_PROGRESS
        - PICKING_PAUSED
        - PICKING_DONE
        - PICKING_DONE_INCOMPLETE
        - PICKING_ABORTED_NO_ITEMS_PICKED
        - PICKING_RESET
        - PICKING_RESTART
        - PICKING_CANCELLED
        - PACKING_CREATED
        - PACKING_IN_PROGRESS
        - PACKING_DONE
        - PARCEL_CREATED
        - PARCEL_LABEL_REQUESTED
        - PARCEL_LABEL_CREATION_FAILED
        - HANDOVER_CREATED
        - HANDOVER_DONE
        - HANDOVER_DONE_WITH_REFUSED_ITEMS
        - HANDOVER_CANCELED
        - SERVICEJOB_CREATED
        - SERVICEJOB_IN_PROGRESS
        - SERVICEJOB_DONE
        - SERVICEJOB_CANCELED
        - ACTION_TRIGGERED
        - COMMENT_ADDED
        - RETURN_ANNOUNCED
        - RETURN_CANCELED
        - RETURN_FINISHED
        - REFUND_TRIGGERED
      type: string
      title: ProcessHistoryEventType
    ProcessHistoryLog:
      allOf:
        - $ref: '#/components/schemas/ProcessHistoryLogBase'
      properties:
        eventType:
          $ref: '#/components/schemas/ProcessHistoryEventType'
        payload:
          description: Payload varies based on eventType
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/RerouteLogPayload'
            - $ref: '#/components/schemas/RerouteLogPayloadBase'
            - $ref: '#/components/schemas/OrderCancellationPayload'
            - $ref: '#/components/schemas/OrderModificationPayloadBase'
            - $ref: '#/components/schemas/ConsumerAddressModifiedLogPayload'
            - $ref: >-
                #/components/schemas/OrderModificationPreferredHandlingTimePayload
            - $ref: '#/components/schemas/StatusReasonsPayload'
            - $ref: '#/components/schemas/OrderLineItemModifiedLogPayload'
            - $ref: '#/components/schemas/OperativeEntityPayloadBase'
            - $ref: '#/components/schemas/ExternalActionHistoryLogPayload'
            - $ref: '#/components/schemas/ParcelLabelCreationFailedPayload'
            - $ref: '#/components/schemas/OperativeEntityPickingDoneIncompletePayload'
            - $ref: '#/components/schemas/ReturnManagementPayloadBase'
          type: object
      required:
        - eventType
      title: ProcessHistoryLog
      description: ProcessHistoryLog
    ProcessHistoryLogBase:
      properties:
        domain:
          $ref: '#/components/schemas/ProcessHistoryDomainType'
        domainRef:
          type: string
        eventCause:
          type: string
        id:
          type: string
        status:
          description: >-
            Status can be OrderStatus, PickJobStatus, PackJobStatus,
            ParcelStatus, HandoverjobStatus, RoutingPlanStatus, ShipmentStatus,
            ItemReturnJobStatus or null
          nullable: true
          type: string
        timestamp:
          description: Timestamp of the moment at which this log entry was created.
          example: 2025-01-01T08:45:50.525Z
          format: date-time
          type: string
        type:
          description: Can be ProcessHistoryLogTypeCommon or user-defined action type
          type: string
        user:
          $ref: '#/components/schemas/ProcessHistoryLogUser'
        version:
          nullable: true
          type: number
        info:
          type: string
      required:
        - id
        - type
        - domain
        - status
        - domainRef
        - version
        - user
        - timestamp
      type: object
      title: ProcessHistoryLogBase
      description: ProcessHistoryLogBase
    ProcessHistoryLogFacility:
      properties:
        facilityGroups:
          items:
            $ref: '#/components/schemas/ProcessHistoryLogFacilityGroup'
          type: array
        facilityRef:
          type: string
        name:
          type: string
        version:
          type: number
      type: object
      title: ProcessHistoryLogFacility
      description: ProcessHistoryLogFacility
    ProcessHistoryLogFacilityGroup:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        facilityGroupRef:
          type: string
        name:
          type: string
        version:
          type: number
      required:
        - facilityGroupRef
        - version
        - nameLocalized
      type: object
      title: ProcessHistoryLogFacilityGroup
      description: ProcessHistoryLogFacilityGroup
    ProcessHistoryLogs:
      properties:
        historyLogs:
          items:
            $ref: '#/components/schemas/ProcessHistoryLog'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 3
          type: integer
      type: object
      title: ProcessHistoryLogs
      description: ProcessHistoryLogs
    ProcessHistoryLogSort:
      description: Attribute to order a process history log by
      enum:
        - TIMESTAMP_DESC
        - TIMESTAMP_ASC
        - INFO_DESC
        - INFO_ASC
        - TYPE_ASC
        - TYPE_DESC
        - USERNAME_DESC
        - USERNAME_ASC
        - FACILITY_NAME_DESC
        - FACILITY_NAME_ASC
      type: string
      xml:
        name: ProcessHistoryLogSort
      title: ProcessHistoryLogSort
    ProcessHistoryLogTypeCommon:
      description: Common log types for process history
      enum:
        - ORDER_LIFECYCLE
        - ROUTING
        - FULFILLMENT
        - ORDER_MODIFICATION
        - COMMENT
        - RETURN_MANAGEMENT
      type: string
      title: ProcessHistoryLogTypeCommon
    ProcessHistoryLogUser:
      properties:
        username:
          type: string
        userRef:
          type: string
      required:
        - userRef
        - username
      type: object
      title: ProcessHistoryLogUser
      description: ProcessHistoryLogUser
    ProcessInput:
      properties:
        handoverJobRef:
          type: string
        orderRef:
          type: string
        pickJobRef:
          type: string
        returnRef:
          type: string
        shipmentRef:
          type: string
        tenantOrderId:
          type: string
      title: ProcessInput
      description: ProcessInput
    ProcessOrderSort:
      properties:
        desiredDeliveryTime:
          enum:
            - ASC
            - DESC
          type: string
        orderDate:
          enum:
            - ASC
            - DESC
          type: string
        orderedAmount:
          enum:
            - ASC
            - DESC
          type: string
        provisioningTime:
          enum:
            - ASC
            - DESC
          type: string
        tenantOrderId:
          enum:
            - ASC
            - DESC
          type: string
        updateDetails:
          allOf:
            - $ref: '#/components/schemas/ProcessUpdateDetailsSort'
          example: 2026-06-17T12:00:00.000Z
      title: ProcessOrderSort
      type: object
      description: ProcessOrderSort
    ProcessPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        processes:
          items:
            $ref: '#/components/schemas/Process'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - processes
      title: ProcessPaginatedResult
      type: object
      description: ProcessPaginatedResult
    ProcessPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/AddTagsToProcess'
              - $ref: '#/components/schemas/AssignFacilityToProcess'
              - $ref: '#/components/schemas/UpdateGdprCleanupDateAction'
          maxItems: 500
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: ProcessPatchActions
      title: ProcessPatchActions
      description: ProcessPatchActions
    ProcessProgressLog:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        attributes:
          type: object
        domain:
          $ref: '#/components/schemas/DomainType'
        domainEntityProcessStatus:
          $ref: '#/components/schemas/DomainStatus'
        domainLastModified:
          description: The last modified date of the related domain entity
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        domainRef:
          type: string
        domainStatus:
          type: string
        domainVersion:
          description: The version of the related domain entity
          example: 1
          format: int64
          type: integer
        facilityRef:
          description: The id of the facility an entity possibly belongs to.
          type: string
        id:
          type: string
        moduleEntity:
          $ref: '#/components/schemas/ModuleEntity'
        moduleEntityLastModified:
          description: The last modified date of the related module entity
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        moduleEntityRef:
          type: string
        moduleEntityStatus:
          description: Original status of the related module entity
          type: string
        moduleEntityStatusForProcess:
          $ref: '#/components/schemas/ModuleEntityStatus'
          description: >-
            Module entity's original status mapped to the ModuleEntityStatus for
            process
        moduleEntitySubStatuses:
          description: >-
            Sub-statuses reported by the module entity for this progress log
            entry.
          items:
            $ref: '#/components/schemas/ProcessSubStatus'
          nullable: true
          type: array
        moduleEntityVersion:
          description: The version of the related module entity
          example: 1
          format: int64
          type: integer
        processRef:
          type: string
        schemaVersion:
          type: number
        statusChangeReasonKey:
          description: >-
            This property captures the reason for the entity’s status change.
            Each module can define its own set of reasons, represented as an
            ENUM
          type: string
      required:
        - id
        - domainVersion
        - processRef
        - domainEntityProcessStatus
        - domain
        - domainRef
        - domainStatus
      title: ProcessProgressLog
      description: ProcessProgressLog
    ProcessReferencedBrandFilter:
      properties:
        name:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by name
      title: ProcessReferencedBrandFilter
      type: object
      description: ProcessReferencedBrandFilter
    ProcessReferencedCarrierFilter:
      properties:
        carrierTrackingNumber:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by carrierTrackingNumber
        name:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by name
      title: ProcessReferencedCarrierFilter
      type: object
      description: ProcessReferencedCarrierFilter
    ProcessReferencedConsumerAddressFilter:
      properties:
        country:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by country
          example: US
        deliveryCountry:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by deliveryCountry
      title: ProcessReferencedConsumerAddressFilter
      type: object
      description: ProcessReferencedConsumerAddressFilter
    ProcessReferencedFacilityAddressFilter:
      properties:
        country:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by country
          example: US
      title: ProcessReferencedFacilityAddressFilter
      type: object
      description: ProcessReferencedFacilityAddressFilter
    ProcessReferencedFacilityFilter:
      properties:
        address:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedFacilityAddressFilter'
          description: Nested search by address
        name:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by name
      title: ProcessReferencedFacilityFilter
      type: object
      description: ProcessReferencedFacilityFilter
    ProcessReferencedFilter:
      properties:
        brand:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedBrandFilter'
          description: Nested search by brand
        carrier:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedCarrierFilter'
          description: Nested search by carrier
        consumerAddress:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedConsumerAddressFilter'
          description: Nested search by consumerAddress
        facility:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedFacilityFilter'
          description: Nested search by facility
        handoverJob:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedHandoverJobFilter'
          description: Nested search by handoverJob
        order:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedOrderFilter'
          description: Nested search by order
        packJob:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedPackJobFilter'
          description: Nested search by packJob
        parcel:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedParcelFilter'
          description: Nested search by parcel
        parcelTrackingStatus:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedParcelTrackingStatusEnumListFilter
          description: Search by parcelTrackingStatus
        pickJob:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedPickJobFilter'
          description: Nested search by pickJob
        returnJob:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedReturnJobFilter'
          description: Nested search by returnJob
        serviceJob:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedServiceJobFilter'
          description: Nested search by serviceJob
        serviceLevel:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedServiceLevelEnumListFilter'
          description: Search by serviceLevel
        serviceType:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by serviceType
        shipment:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedShipmentFilter'
          description: Nested search by shipment
        sticker:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedStickerFilter'
          description: Nested search by sticker
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
      title: ProcessReferencedFilter
      type: object
      description: ProcessReferencedFilter
    ProcessReferencedHandoverJobFilter:
      properties:
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedHandoverJobFilter
      type: object
      description: ProcessReferencedHandoverJobFilter
    ProcessReferencedHandoverJobHandoverjobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - HANDED_OVER
            - OBSOLETE
            - CANCELED
            - WAITING_FOR_INPUT
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - HANDED_OVER
              - OBSOLETE
              - CANCELED
              - WAITING_FOR_INPUT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - HANDED_OVER
            - OBSOLETE
            - CANCELED
            - WAITING_FOR_INPUT
          type: string
      title: ProcessReferencedHandoverJobHandoverjobStatusEnumFilter
      type: object
      description: ProcessReferencedHandoverJobHandoverjobStatusEnumFilter
    ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedHandoverJobHandoverjobStatusEnumFilter
          description: Search by status
      title: ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter
      type: object
      description: ProcessReferencedHandoverJobHandoverjobStatusEnumListFilter
    ProcessReferencedOrderFilter:
      properties:
        consumerId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by consumerId
        desiredDeliveryTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by desiredDeliveryTime
          example: 2026-06-17T12:00:00.000Z
        orderDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by orderDate
          example: 2026-06-17T12:00:00.000Z
        orderedAmount:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by orderedAmount
        provisioningTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by provisioningTime
          example: 2026-06-17T12:00:00.000Z
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedOrderOrderStatusEnumListFilter
          description: Search by status
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: ProcessReferencedOrderFilter
      type: object
      description: ProcessReferencedOrderFilter
    ProcessReferencedOrderOrderStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - CANCELLED
              - PROMISED
              - LOCKED
              - OBSOLETE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
      title: ProcessReferencedOrderOrderStatusEnumFilter
      type: object
      description: ProcessReferencedOrderOrderStatusEnumFilter
    ProcessReferencedOrderOrderStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedOrderOrderStatusEnumFilter'
          description: Search by status
      title: ProcessReferencedOrderOrderStatusEnumListFilter
      type: object
      description: ProcessReferencedOrderOrderStatusEnumListFilter
    ProcessReferencedPackJobFilter:
      properties:
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedPackJobPackJobStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedPackJobFilter
      type: object
      description: ProcessReferencedPackJobFilter
    ProcessReferencedPackJobPackJobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - OBSOLETE
            - CANCELED
            - PAUSED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - IN_PROGRESS
              - CLOSED
              - OBSOLETE
              - CANCELED
              - PAUSED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - OBSOLETE
            - CANCELED
            - PAUSED
          type: string
      title: ProcessReferencedPackJobPackJobStatusEnumFilter
      type: object
      description: ProcessReferencedPackJobPackJobStatusEnumFilter
    ProcessReferencedPackJobPackJobStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedPackJobPackJobStatusEnumFilter
          description: Search by status
      title: ProcessReferencedPackJobPackJobStatusEnumListFilter
      type: object
      description: ProcessReferencedPackJobPackJobStatusEnumListFilter
    ProcessReferencedParcelFilter:
      properties:
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedParcelParcelStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedParcelFilter
      type: object
      description: ProcessReferencedParcelFilter
    ProcessReferencedParcelParcelStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - PROCESSING
            - DONE
            - FAILED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - PROCESSING
              - DONE
              - FAILED
              - CANCELED
              - OBSOLETE
              - WAITING_FOR_INPUT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - PROCESSING
            - DONE
            - FAILED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
          type: string
      title: ProcessReferencedParcelParcelStatusEnumFilter
      type: object
      description: ProcessReferencedParcelParcelStatusEnumFilter
    ProcessReferencedParcelParcelStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedParcelParcelStatusEnumFilter
          description: Search by status
      title: ProcessReferencedParcelParcelStatusEnumListFilter
      type: object
      description: ProcessReferencedParcelParcelStatusEnumListFilter
    ProcessReferencedParcelTrackingStatusEnumFilter:
      properties:
        eq:
          description: Search by parcelTrackingStatus
          enum:
            - REGISTERED
            - PICKED_UP
            - DELIVERED
            - NOT_DELIVERED
            - TRANSIT
            - EXCEPTION
            - OUT_FOR_DELIVERY
            - DESTROYED
            - UNKNOWN
            - CANCELED
            - AWAITS_PICKUP_BY_RECEIVER
            - DELAYED
            - NOTIFICATION
          type: string
        in:
          description: Search by parcelTrackingStatus
          items:
            enum:
              - REGISTERED
              - PICKED_UP
              - DELIVERED
              - NOT_DELIVERED
              - TRANSIT
              - EXCEPTION
              - OUT_FOR_DELIVERY
              - DESTROYED
              - UNKNOWN
              - CANCELED
              - AWAITS_PICKUP_BY_RECEIVER
              - DELAYED
              - NOTIFICATION
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by parcelTrackingStatus
          enum:
            - REGISTERED
            - PICKED_UP
            - DELIVERED
            - NOT_DELIVERED
            - TRANSIT
            - EXCEPTION
            - OUT_FOR_DELIVERY
            - DESTROYED
            - UNKNOWN
            - CANCELED
            - AWAITS_PICKUP_BY_RECEIVER
            - DELAYED
            - NOTIFICATION
          type: string
      title: ProcessReferencedParcelTrackingStatusEnumFilter
      type: object
      description: ProcessReferencedParcelTrackingStatusEnumFilter
    ProcessReferencedParcelTrackingStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedParcelTrackingStatusEnumFilter
          description: Search by parcelTrackingStatus
      title: ProcessReferencedParcelTrackingStatusEnumListFilter
      type: object
      description: ProcessReferencedParcelTrackingStatusEnumListFilter
    ProcessReferencedPickJobFilter:
      properties:
        shortId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by shortId
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedPickJobPickJobStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedPickJobFilter
      type: object
      description: ProcessReferencedPickJobFilter
    ProcessReferencedPickJobPickJobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - ABORTED
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - PICKED
            - REROUTED
            - REJECTED
            - RESTOWED
            - EXPIRED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
            - PAUSED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - ABORTED
              - OPEN
              - IN_PROGRESS
              - CLOSED
              - PICKED
              - REROUTED
              - REJECTED
              - RESTOWED
              - EXPIRED
              - CANCELED
              - OBSOLETE
              - WAITING_FOR_INPUT
              - PAUSED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - ABORTED
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - PICKED
            - REROUTED
            - REJECTED
            - RESTOWED
            - EXPIRED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
            - PAUSED
          type: string
      title: ProcessReferencedPickJobPickJobStatusEnumFilter
      type: object
      description: ProcessReferencedPickJobPickJobStatusEnumFilter
    ProcessReferencedPickJobPickJobStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedPickJobPickJobStatusEnumFilter
          description: Search by status
      title: ProcessReferencedPickJobPickJobStatusEnumListFilter
      type: object
      description: ProcessReferencedPickJobPickJobStatusEnumListFilter
    ProcessReferencedReturnJobFilter:
      properties:
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedReturnJobFilter
      type: object
      description: ProcessReferencedReturnJobFilter
    ProcessReferencedReturnJobItemReturnJobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - IN_PROGRESS
              - FINISHED
              - CANCELED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELED
          type: string
      title: ProcessReferencedReturnJobItemReturnJobStatusEnumFilter
      type: object
      description: ProcessReferencedReturnJobItemReturnJobStatusEnumFilter
    ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedReturnJobItemReturnJobStatusEnumFilter
          description: Search by status
      title: ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter
      type: object
      description: ProcessReferencedReturnJobItemReturnJobStatusEnumListFilter
    ProcessReferencedServiceJobFilter:
      properties:
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedServiceJobFilter
      type: object
      description: ProcessReferencedServiceJobFilter
    ProcessReferencedServiceJobServiceJobStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - WAITING_FOR_INPUT
            - OBSOLETE
            - NOT_READY
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - IN_PROGRESS
              - FINISHED
              - CANCELLED
              - WAITING_FOR_INPUT
              - OBSOLETE
              - NOT_READY
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - WAITING_FOR_INPUT
            - OBSOLETE
            - NOT_READY
          type: string
      title: ProcessReferencedServiceJobServiceJobStatusEnumFilter
      type: object
      description: ProcessReferencedServiceJobServiceJobStatusEnumFilter
    ProcessReferencedServiceJobServiceJobStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedServiceJobServiceJobStatusEnumFilter
          description: Search by status
      title: ProcessReferencedServiceJobServiceJobStatusEnumListFilter
      type: object
      description: ProcessReferencedServiceJobServiceJobStatusEnumListFilter
    ProcessReferencedServiceLevelEnumFilter:
      properties:
        eq:
          description: Search by serviceLevel
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
        in:
          description: Search by serviceLevel
          items:
            enum:
              - DELIVERY
              - SAMEDAY
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by serviceLevel
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
      title: ProcessReferencedServiceLevelEnumFilter
      type: object
      description: ProcessReferencedServiceLevelEnumFilter
    ProcessReferencedServiceLevelEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedServiceLevelEnumFilter'
          description: Search by serviceLevel
      title: ProcessReferencedServiceLevelEnumListFilter
      type: object
      description: ProcessReferencedServiceLevelEnumListFilter
    ProcessReferencedShipmentFilter:
      properties:
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedShipmentShipmentStatusEnumListFilter
          description: Search by status
      title: ProcessReferencedShipmentFilter
      type: object
      description: ProcessReferencedShipmentFilter
    ProcessReferencedShipmentShipmentStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - INITIAL
            - REQUEST
            - RETRYABLE
            - CONFIRMED
            - COMPLETED
            - CANCELED
            - OBSOLETE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - INITIAL
              - REQUEST
              - RETRYABLE
              - CONFIRMED
              - COMPLETED
              - CANCELED
              - OBSOLETE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - INITIAL
            - REQUEST
            - RETRYABLE
            - CONFIRMED
            - COMPLETED
            - CANCELED
            - OBSOLETE
          type: string
      title: ProcessReferencedShipmentShipmentStatusEnumFilter
      type: object
      description: ProcessReferencedShipmentShipmentStatusEnumFilter
    ProcessReferencedShipmentShipmentStatusEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ProcessReferencedShipmentShipmentStatusEnumFilter
          description: Search by status
      title: ProcessReferencedShipmentShipmentStatusEnumListFilter
      type: object
      description: ProcessReferencedShipmentShipmentStatusEnumListFilter
    ProcessReferencedSort:
      properties:
        brand:
          $ref: '#/components/schemas/ProcessBrandSort'
        carrier:
          $ref: '#/components/schemas/ProcessCarrierSort'
        consumerAddress:
          $ref: '#/components/schemas/ProcessConsumerAddressSort'
        facility:
          $ref: '#/components/schemas/ProcessFacilitySort'
        order:
          $ref: '#/components/schemas/ProcessOrderSort'
        parcelTrackingStatus:
          enum:
            - ASC
            - DESC
          type: string
        sticker:
          $ref: '#/components/schemas/ProcessStickerSort'
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessReferencedSort
      type: object
      description: ProcessReferencedSort
    ProcessReferencedStickerFilter:
      properties:
        name:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by name
      title: ProcessReferencedStickerFilter
      type: object
      description: ProcessReferencedStickerFilter
    ProcessSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ProcessSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ProcessSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ProcessSearchPayload
      type: object
      description: ProcessSearchPayload
    ProcessSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ProcessSearchQuery'
          maxItems: 500
          type: array
        carrierManagementStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusEnumFilter'
          description: Search by carrierManagementStatuses
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by created
        documentRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by documentRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        domainStatuses:
          allOf:
            - $ref: '#/components/schemas/ProcessDomainStatusesFilter'
          description: Nested search by domainStatuses
        domsStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusEnumFilter'
          description: Search by domsStatus
        externalActionRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by externalActionRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        facilityRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by facilityRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        facilityRefsWithActiveOperations:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRefsWithActiveOperations
        flatRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by flatRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        handoverJobRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by handoverJobRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        inventoryStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusEnumFilter'
          description: Search by inventoryStatus
        itemReturnJobsRef:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by itemReturnJobsRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        operativeStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusEnumFilter'
          description: Search by operativeStatus
        or:
          items:
            $ref: '#/components/schemas/ProcessSearchQuery'
          maxItems: 500
          type: array
        orderRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by orderRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        packJobRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by packJobRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        pickJobRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by pickJobRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        processId:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by processId
        referenced:
          allOf:
            - $ref: '#/components/schemas/ProcessReferencedFilter'
          description: Nested search by referenced
        returnRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by returnRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        returnStatus:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusEnumFilter'
          description: Search by returnStatus
        routingPlanRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by routingPlanRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        searchTerm:
          allOf:
            - $ref: '#/components/schemas/SearchFilter'
          description: Full-text search for this entity
        serviceJobRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by serviceJobRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        shipmentRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by shipmentRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        status:
          allOf:
            - $ref: '#/components/schemas/ProcessStatusEnumFilter'
          description: Search by status
        tags:
          allOf:
            - $ref: '#/components/schemas/ProcessTagsListFilter'
          description: Nested list search by tags
      title: ProcessSearchQuery
      type: object
      description: ProcessSearchQuery
    ProcessSearchResult:
      properties:
        created:
          description: Information about the time, when a routing plan status is set
          example: 2024-05-12T08:45:50.525Z
          format: date-time
          type: string
        id:
          type: string
        lastModified:
          description: Information about the time, when a routing plan status is set
          example: 2024-05-12T08:45:50.525Z
          format: date-time
          type: string
        processSearchResultEntities:
          type: object
        version:
          type: integer
      required:
        - id
        - version
        - created
        - lastModified
        - processSearchResultEntities
      title: ProcessSearchResult
      type: object
      description: ProcessSearchResult
    ProcessSort:
      properties:
        activeFacilityCountry:
          enum:
            - ASC
            - DESC
          type: string
        activeFacilityName:
          enum:
            - ASC
            - DESC
          type: string
        domsStatus:
          enum:
            - ASC
            - DESC
          type: string
        inventoryStatus:
          enum:
            - ASC
            - DESC
          type: string
        operativeStatus:
          enum:
            - ASC
            - DESC
          type: string
        processId:
          enum:
            - ASC
            - DESC
          type: string
        referenced:
          $ref: '#/components/schemas/ProcessReferencedSort'
        returnStatus:
          enum:
            - ASC
            - DESC
          type: string
        status:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessSort
      type: object
      description: ProcessSort
    ProcessStatus:
      enum:
        - CREATED
        - IN_PROGRESS
        - FINISHED
        - CANCELED
        - ERROR
        - NOT_AVAILABLE
      type: string
      title: ProcessStatus
      description: ProcessStatus
    ProcessStatusDetail:
      properties:
        status:
          $ref: '#/components/schemas/ProcessStatus'
        subStatuses:
          items:
            $ref: '#/components/schemas/ProcessSubStatus'
          nullable: true
          type: array
        subStatusHistory:
          items:
            $ref: '#/components/schemas/ProcessSubStatus'
          type: array
      required:
        - status
      type: object
      title: ProcessStatusDetail
      description: ProcessStatusDetail
    ProcessStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - CREATED
            - IN_PROGRESS
            - FINISHED
            - CANCELED
            - ERROR
            - NOT_AVAILABLE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - CREATED
              - IN_PROGRESS
              - FINISHED
              - CANCELED
              - ERROR
              - NOT_AVAILABLE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - CREATED
            - IN_PROGRESS
            - FINISHED
            - CANCELED
            - ERROR
            - NOT_AVAILABLE
          type: string
      title: ProcessStatusEnumFilter
      type: object
      description: ProcessStatusEnumFilter
    ProcessStickerSort:
      properties:
        name:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessStickerSort
      type: object
      description: ProcessStickerSort
    ProcessSubStatus:
      enum:
        - MISMATCH
        - DELAYED
        - AT_RISK
      type: string
      title: ProcessSubStatus
      description: ProcessSubStatus
    ProcessTagsFilter:
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        value:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by value
      title: ProcessTagsFilter
      type: object
      description: ProcessTagsFilter
    ProcessTagsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ProcessTagsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ProcessTagsListFilter
      type: object
      description: ProcessTagsListFilter
    ProcessUpdateDetailsSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        user:
          enum:
            - ASC
            - DESC
          type: string
      title: ProcessUpdateDetailsSort
      type: object
      description: ProcessUpdateDetailsSort
    ProcessWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Process'
      required:
        - payload
      type: object
      title: ProcessWebHookEvent
      description: ProcessWebHookEvent
    ProductInformation:
      properties:
        additionalShippingArticleAttributes:
          items:
            $ref: '#/components/schemas/AdditionalShippingArticleAttribute'
          type: array
        additionalShippingAttributes:
          items:
            $ref: '#/components/schemas/AdditionalShippingAttribute'
          type: array
        carrierCountryServiceMappingRef:
          description: Id of the used CarrierCountryServiceMapping
          type: string
        mandatoryShippingArticleAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingArticleAttribute'
          type: array
        mandatoryShippingAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingAttribute'
          type: array
        mandatoryShippingItemAttributes:
          items:
            $ref: '#/components/schemas/MandatoryShippingItemAttribute'
          type: array
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          deprecated: true
        productName:
          description: The name of the product used by the carrier
          example: Express
          type: string
      title: ProductInformation
      description: ProductInformation
    ProductValueCurrency:
      additionalProperties: false
      properties:
        currency:
          description: Currency of the given value
          example: EUR
          type: string
        decimalPlaces:
          description: Number of decimal places for the given currency
          example: 2
          type: integer
      required:
        - currency
      type: object
      title: ProductValueCurrency
      description: ProductValueCurrency
    ProductValueType:
      enum:
        - INSURANCE
        - CUSTOMS
        - SHOP_PRICE
      example: INSURANCE
      type: string
      title: ProductValueType
      description: ProductValueType
    PromiseCarrier:
      additionalProperties: false
      properties:
        carrierKey:
          type: string
        carrierName:
          type: string
        carrierRef:
          type: string
        deliveryPromiseValidUntil:
          format: date-time
          type: string
        products:
          items:
            $ref: '#/components/schemas/PromiseDeliveryOptions'
          type: array
      required:
        - carrierRef
        - carrierKey
        - carrierName
        - products
      type: object
      xml:
        name: PromiseCarrier
      title: PromiseCarrier
      description: PromiseCarrier
    PromiseConfirmActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      description: Action to confirm a promise.
      properties:
        name:
          enum:
            - CONFIRM_PROMISE
          type: string
        tenantOrderId:
          description: The tenantOrderId to be used for the resulting order
          type: string
      required:
        - name
        - version
      title: PromiseConfirmActionParameter
    PromiseDeliveryOptions:
      additionalProperties: false
      properties:
        carrierProductCategory:
          $ref: '#/components/schemas/CarrierProductCategory'
        deliveryCosts:
          items:
            $ref: '#/components/schemas/DeliveryCost'
          type: array
        estimatedDeliveryTime:
          $ref: '#/components/schemas/EstimatedDeliveryTime'
        transitTime:
          $ref: '#/components/schemas/CarrierTransitTime'
      required:
        - carrierProductCategory
        - deliveryCosts
      type: object
      xml:
        name: PromiseDeliveryOptions
      title: PromiseDeliveryOptions
      description: PromiseDeliveryOptions
    PromiseExtendActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractOrderActionsParameter'
      description: Action to extend a promise.
      properties:
        name:
          enum:
            - EXTEND_PROMISE
          type: string
      required:
        - name
        - version
      title: PromiseExtendActionParameter
    PromiseRequest:
      additionalProperties: false
      properties:
        additionalInfo:
          $ref: '#/components/schemas/PromiseRequestAdditionalInfo'
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
        customAttributes:
          description: >-
            Attributes that can be added to the order. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        customServices:
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          minItems: 1
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
        orderDate:
          description: The date this order was created at the supplying system.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
        status:
          $ref: '#/components/schemas/OrderStatus'
        statusReasons:
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          minItems: 1
          type: array
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: R456728546
          type: string
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - orderDate
        - orderLineItems
        - consumer
      xml:
        name: PromiseRequest
      title: PromiseRequest
      description: PromiseRequest
    PromiseRequestAdditionalInfo:
      properties:
        includeListingCustomAttributes:
          default: false
          description: >-
            If true, the listing custom attributes are included in the response.
            This is useful for debugging purposes.
          type: boolean
        resourceInvestment:
          $ref: '#/components/schemas/ResourceInvestment'
      type: object
      title: PromiseRequestAdditionalInfo
      description: PromiseRequestAdditionalInfo
    PromisesConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        invalidAfterTime:
          default: PT8H
          description: >-
            Default amount of time in ISO 8601 duration format after which an
            promised order becomes invalid and is cancelled. The duration need
            to be a multiple of 60 seconds.
          pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
      required:
        - invalidAfterTime
      title: PromisesConfiguration
      description: PromisesConfiguration
    ProvidedSection:
      properties:
        diagnostics:
          items:
            $ref: '#/components/schemas/PickingOutcomeDiagnostic'
          type: array
      required:
        - diagnostics
      title: ProvidedSection
      type: object
      description: ProvidedSection
    PurchaseOrder:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        id:
          type: string
        inboundProcessRef:
          type: string
        lastModified:
          format: date-time
          type: string
        orderDate:
          description: >-
            Time and date at which the order was placed. Note: This does not
            refer to the creation date of this entity in the system.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/RequestedDate'
          description: >-
            Time and date at which the order is expected to arrive. Use 'ASAP'
            for deliveries with unknown date, but be aware that some features
            will not include these orders.
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          description: Line items which are expected to be delivered.
          items:
            $ref: '#/components/schemas/InboundLineItem'
          maxItems: 200
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
        transfer:
          allOf:
            - $ref: '#/components/schemas/InboundProcessPurchaseOrderTransfer'
          description: >-
            Includes data about transfer between different facilities in the
            tenant's network.
        version:
          type: number
      required:
        - orderDate
        - requestedDate
        - requestedItems
        - status
        - cancelled
        - id
        - created
        - lastModified
        - version
        - facilityRef
        - inboundProcessRef
      title: PurchaseOrder
      type: object
      description: PurchaseOrder
    PurchaseOrderEventPayload:
      properties:
        canceled:
          type: boolean
        created:
          format: date-time
          type: string
        customAttributes:
          type: object
        facilityRef:
          type: string
        id:
          type: string
        inboundProcessRef:
          type: string
        lastModified:
          format: date-time
          type: string
        orderDate:
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/RequestedDate'
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          items:
            $ref: '#/components/schemas/InboundLineItem'
          type: array
        status:
          type: string
        supplier:
          $ref: '#/components/schemas/PurchaseOrderSupplier'
        tenantInboundProcessId:
          type: string
        transfer:
          $ref: '#/components/schemas/PurchaseOrderTransfer'
        version:
          type: number
      required:
        - id
        - orderDate
        - requestedDate
        - requestedItems
        - inboundProcessRef
        - facilityRef
        - created
        - lastModified
        - canceled
        - status
        - version
      title: PurchaseOrderEventPayload
      type: object
      description: PurchaseOrderEventPayload
    PurchaseOrderForCreation:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          minLength: 1
          type: string
        orderDate:
          description: >-
            Time and date at which the order was placed. Note: This does not
            refer to the creation date of this entity in the system.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/InputRequestedDate'
          description: >-
            Time and date at which the order is expected to arrive. Use 'ASAP'
            for deliveries with unknown date, but be aware that some features
            will not include these orders.
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          description: Line items which are expected to be delivered.
          items:
            $ref: '#/components/schemas/InboundLineItem'
          maxItems: 200
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
      required:
        - orderDate
        - requestedDate
        - requestedItems
        - facilityRef
      title: PurchaseOrderForCreation
      type: object
      description: PurchaseOrderForCreation
    PurchaseOrderForPartialUpdate:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        orderDate:
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/InputRequestedDate'
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          items:
            $ref: '#/components/schemas/InboundLineItem'
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
        version:
          type: number
      required:
        - version
      title: PurchaseOrderForPartialUpdate
      type: object
      description: PurchaseOrderForPartialUpdate
    PurchaseOrderForUpdate:
      properties:
        cancelled:
          deprecated: true
          description: >-
            This field is deprecated. Set the status to 'CANCELED' Set the
            purchaseOrder to 'cancelled'. No further deliveries will be
            expected. Already received goods are unaffected.
          type: boolean
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        orderDate:
          description: >-
            Time and date at which the order was placed. Note: This does not
            refer to the creation date of this entity in the system.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        requestedDate:
          allOf:
            - $ref: '#/components/schemas/InputRequestedDate'
          description: >-
            Time and date at which the order is expected to arrive. Use 'ASAP'
            for deliveries with unknown date, but be aware that some features
            will not include these orders.
          example: 2026-06-17T12:00:00.000Z
        requestedItems:
          description: Line items which are expected to be delivered.
          items:
            $ref: '#/components/schemas/InboundLineItem'
          maxItems: 200
          type: array
        status:
          enum:
            - OPEN
            - CANCELED
          type: string
        supplier:
          $ref: '#/components/schemas/InboundProcessPurchaseOrderSupplier'
        version:
          type: number
      required:
        - orderDate
        - requestedDate
        - requestedItems
        - version
      title: PurchaseOrderForUpdate
      type: object
      description: PurchaseOrderForUpdate
    PurchaseOrderSupplier:
      properties:
        facilityRef:
          type: string
        name:
          type: string
      title: PurchaseOrderSupplier
      type: object
      description: PurchaseOrderSupplier
    PurchaseOrderTransfer:
      properties:
        id:
          type: string
      required:
        - id
      title: PurchaseOrderTransfer
      type: object
      description: PurchaseOrderTransfer
    PurchaseOrderWebHookEvent:
      properties:
        payload:
          $ref: '#/components/schemas/PurchaseOrderEventPayload'
      required:
        - payload
      title: PurchaseOrderWebHookEvent
      type: object
      description: PurchaseOrderWebHookEvent
    PurchasePrice:
      properties:
        currency:
          $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the purchase price.
        decimalPlaces:
          description: The number of decimal places for the purchase price.
          type: number
        value:
          description: The value of the purchase price.
          type: number
      required:
        - value
        - currency
        - decimalPlaces
      title: PurchasePrice
      type: object
      description: PurchasePrice
    PurchasePriceResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the purchase prices.
        purchasePrices:
          description: The calculated purchase prices for the target listing.
          items:
            $ref: '#/components/schemas/CalculatedPurchasePrice'
          type: array
      required:
        - purchasePrices
        - pageInfo
      title: PurchasePriceResult
      type: object
      description: PurchasePriceResult
    Quantity:
      properties:
        unit:
          description: >-
            Unit of measurement for the requested quantity. Must match the
            measurementUnitKey defined in the corresponding listing, if set.
          type: string
        value:
          description: The amount, provided in the unit of the quantity.
          example: 42
          format: int32
          minimum: 0
          type: integer
      required:
        - value
      title: Quantity
      type: object
      description: Quantity
    Rating:
      additionalProperties: false
      description: >-
        A rating is used to rate a set of possible facilities against each other
        during routing of orders.
      properties:
        active:
          type: boolean
        configuration:
          $ref: '#/components/schemas/AbstractRatingConfiguration'
        description:
          type: string
        id:
          description: >-
            This value identifies this very instance of the rating. It is set
            automatically by the server when the configuration is updated.
          example: 579ff115-8941-4221-8530-04f8b4adf59f
          type: string
        implementation:
          $ref: '#/components/schemas/RatingImplementation'
        maxPenalty:
          example: 100
          minimum: 0
          type: number
        name:
          type: string
      required:
        - name
        - active
        - implementation
        - maxPenalty
        - id
      type: object
      title: Rating
    RatingConfigurationType:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Identifies the rating configuration variant and determines which
        properties are applicable.
      enum:
        - COST_COMPONENTS
      type: string
      xml:
        name: RatingConfigurationType
      title: RatingConfigurationType
      x-badges:
        - color: orange
          label: BETA
    RatingImplementation:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />Discriminator identifying a rating variant.
      enum:
        - STOCK-BALANCING
        - GEO-DISTANCE
        - TURNOVER
        - STOCK-AVAILABILITY
        - WORKLOAD-BALANCING
        - MATCHING-BUSINESSTYPE
        - PREFER-STORE
        - PREFER-WAREHOUSE
        - ZONE
        - EXPIRY-DATE
        - CAPACITY
        - DELIVERY-COSTS
        - DELIVERY-TIME
        - COST-COMPONENTS
        - NUMBER-OF-DELIVERIES
      type: string
      xml:
        name: RatingImplementation
      title: RatingImplementation
      x-badges:
        - color: orange
          label: BETA
    RatingResult:
      properties:
        id:
          type: string
        name:
          type: string
        penalty:
          type: number
        routingStrategyNodeId:
          type: string
        type:
          description: The type of the rating, e.g. 'StandardRating' or 'ToolkitRating'
          type: string
      required:
        - penalty
        - id
        - type
        - routingStrategyNodeId
        - name
      title: RatingResult
      description: RatingResult
    RatingResultType:
      enum:
        - STANDARD
        - TOOLKIT
      type: string
      xml:
        name: RatingResultType
      title: RatingResultType
      description: RatingResultType
    RatingStatistic:
      properties:
        durationMs:
          description: Duration in Milliseconds
          type: number
        maxPenalty:
          type: number
        maxScore:
          type: number
        minScore:
          type: number
        name:
          type: string
      required:
        - name
        - maxPenalty
        - durationMs
      title: RatingStatistic
      description: RatingStatistic
    ReactiveErrorReason:
      enum:
        - BACKORDER_LISTING
        - PREORDER_LISTING
      title: ReactiveErrorReason
      description: ReactiveErrorReason
    ReassignmentInformation:
      properties:
        reassignedItems:
          items:
            $ref: '#/components/schemas/AssignmentItem'
          type: array
        sourceFacility:
          $ref: '#/components/schemas/DecisionLogFacilityInfo'
      required:
        - sourceFacility
        - reassignedItems
      title: ReassignmentInformation
      description: ReassignmentInformation
    Receipt:
      properties:
        asnRef:
          description: enables mapping a receipt to one of the ASNs in this inbound process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptComment'
          maxItems: 20
          type: array
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        inboundProcessRef:
          type: string
        lastModified:
          format: date-time
          type: string
        receivedDate:
          description: date-time of the arrival of the items in the facility
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        receivedItems:
          description: list of item that arrived in the facility
          items:
            $ref: '#/components/schemas/InboundReceiptLineItem'
          maxItems: 200
          type: array
        status:
          description: >-
            status of this receipt, only receipts with status 'FINISHED' are
            booked. IN_PROGRESS can be used to save partial receipts.
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
        version:
          type: number
      required:
        - receivedDate
        - receivedItems
        - comments
        - id
        - inboundProcessRef
        - version
        - created
        - lastModified
      title: Receipt
      type: object
      description: Receipt
    ReceiptForCreation:
      properties:
        asnRef:
          description: enables mapping a receipt to one of the ASNs in this inbound process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        comments:
          description: comments regarding the receipt itself
          items:
            $ref: '#/components/schemas/InboundReceiptCommentForCreation'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        receivedDate:
          description: date-time of the arrival of the items in the facility
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        receivedItems:
          description: list of item that arrived in the facility
          items:
            $ref: '#/components/schemas/InboundReceiptLineItemForCreation'
          maxItems: 200
          type: array
        status:
          description: >-
            status of this receipt, only receipts with status 'FINISHED' are
            booked. IN_PROGRESS can be used to save partial receipts.
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
          type: string
      required:
        - receivedDate
        - receivedItems
        - comments
        - facilityRef
      title: ReceiptForCreation
      type: object
      description: ReceiptForCreation
    RecommendationConfiguration:
      properties:
        priceType:
          description: >-
            Defines the price attribute category of which the price value is
            taken for carrier recommendation calculation
          enum:
            - customs
            - insurance
            - shop
            - salesPrice
            - basePrice
            - tax
          type: string
      required:
        - priceType
      title: RecommendationConfiguration
      type: object
      description: RecommendationConfiguration
    RecommendedCarrier:
      properties:
        carrierProduct:
          description: Carrier product that has been selected.
          example: EXPRESS
          type: string
        carrierRef:
          description: Reference to the recommended carrier
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        carrierServices:
          description: Carrier services that have been selected
          example:
            - IDENTITY_CHECK
            - AGE_VERIFICATION
          items:
            type: string
          maxItems: 20
          type: array
      required:
        - carrierRef
      title: RecommendedCarrier
      type: object
      description: RecommendedCarrier
    RecordableAttribute:
      additionalProperties: false
      properties:
        keyLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations of the key
        group:
          description: The group of the attribute
          example: general
          minLength: 1
          nullable: true
          type: string
        id:
          description: ID of the recordable attribute
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          type: string
        key:
          description: >-
            The translated key of the attribute. This field gets filled
            automatically on request
          example: country of origin
          type: string
        originId:
          description: The ID of the original lineItem the attribute was split from.
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          nullable: true
          type: string
        recordingRule:
          description: Indicates whether the value has to be recorded or not
          enum:
            - OPTIONAL
            - MANDATORY
          example: MANDATORY
          type: string
        value:
          description: The value of the attribute
          example: Germany
          minLength: 1
          nullable: true
          type: string
      required:
        - id
        - keyLocalized
        - recordingRule
      title: RecordableAttribute
      type: object
      description: RecordableAttribute
    RecordableAttributeForCreation:
      additionalProperties: false
      properties:
        keyLocalized:
          $ref: '#/components/schemas/LocaleString'
        group:
          description: The group of the attribute
          example: general
          minLength: 1
          nullable: true
          type: string
        recordingRule:
          description: Indicates whether the value has to be recorded or not
          enum:
            - OPTIONAL
            - MANDATORY
          example: MANDATORY
          type: string
        value:
          description: The value of the attribute
          example: Germany
          nullable: true
          type: string
      required:
        - keyLocalized
        - recordingRule
      title: RecordableAttributeForCreation
      type: object
      description: RecordableAttributeForCreation
    RecordableAttributeForUpdate:
      additionalProperties: false
      properties:
        keyLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations of the key
        group:
          description: The group of the attribute to set
          example: general
          minLength: 1
          nullable: true
          type: string
        recordableAttributeId:
          description: ID of the recordable attribute to update
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          type: string
        recordingRule:
          description: Indicates whether the value has to be recorded or not
          enum:
            - OPTIONAL
            - MANDATORY
          example: MANDATORY
          type: string
        value:
          description: The value of the attribute to set
          example: Germany
          nullable: true
          type: string
      required:
        - recordableAttributeId
      title: RecordableAttributeForUpdate
      type: object
      description: RecordableAttributeForUpdate
    ReductionSection:
      properties:
        diagnostics:
          items:
            $ref: '#/components/schemas/PickingOutcomeDiagnostic'
          type: array
      required:
        - diagnostics
      title: ReductionSection
      type: object
      description: ReductionSection
    RefundTrigger:
      properties:
        created:
          description: Date when the refund was triggered
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        itemReturnJobRef:
          description: >-
            reference to the item return job which is connected to the item
            return
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
        itemReturnJobVersion:
          description: version of the item return job had during the refund trigger
          example: 1
          type: integer
        itemReturnRef:
          description: reference to the item return that should be refunded
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
        refundedLineItems:
          description: The line items that should be refunded
          items:
            $ref: '#/components/schemas/ItemReturnLineItem'
          type: array
        returnFacilityRef:
          description: The facility where the return was processed
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          type: string
        tenantOrderId:
          description: The tenant order id of the order that should be refunded
          example: a69006ba-7100-4b4d-a610-1ca28016a4eb
          maxLength: 256
          minLength: 1
          type: string
      required:
        - created
        - refundedLineItems
        - returnFacilityRef
        - itemReturnRef
      title: RefundTrigger
      type: object
      description: RefundTrigger
    RefundTriggeredWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RefundTrigger'
      required:
        - payload
      type: object
      title: RefundTriggeredWebHookEvent
      description: RefundTriggeredWebHookEvent
    RefusedItem:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        comment:
          type: string
        quantity:
          minimum: 0
          type: integer
        reason:
          type: string
      required:
        - quantity
      title: RefusedItem
      description: RefusedItem
    RefusedItemForUpdate:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        comment:
          type: string
        quantity:
          minimum: 0
          type: integer
      required:
        - quantity
      title: RefusedItemForUpdate
      description: RefusedItemForUpdate
    RegionInformation:
      properties:
        countryCode:
          description: ISO 3166 ALPHA-2 of country
          example: DE
          maxLength: 2
          minLength: 2
          type: string
        postalCodes:
          description: List of postal codes for this region
          items:
            type: string
          maxItems: 100
          type: array
      required:
        - countryCode
      title: RegionInformation
      type: object
      description: RegionInformation
    RelatedRefs:
      properties:
        orderRefs:
          items:
            type: string
          type: array
        pickJobRefs:
          items:
            type: string
          type: array
        processRefs:
          items:
            type: string
          type: array
        routingPlanRefs:
          items:
            type: string
          type: array
        transferRefs:
          items:
            type: string
          type: array
      title: RelatedRefs
      type: object
      description: RelatedRefs
    RemoteConfiguration:
      properties:
        created:
          description: The date this entity was created at the platform
          format: date-time
          type: string
        flattenScopeIds:
          description: >-
            Generated flatten unique ids of all scope sub elements (userRef,
            facilityRef)
          example:
            - INVENTORY
            - 67151fc3-3ce1-400e-8b23-23c29e0cde90
          items:
            type: string
          type: array
        groups:
          description: Groups this configuration belongs to
          example:
            - INVENTORY
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        id:
          description: Auto generated unique identifier
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        key:
          description: Unique business key of this entity
          example: PICKING_SHOW_NEW_SCAN_VIEW
          type: string
        lastModified:
          description: The date this entity was modified last
          format: date-time
          type: string
        scopes:
          description: Scopes for this remote configuration
          items:
            $ref: '#/components/schemas/RemoteConfigurationScope'
          maxItems: 20
          type: array
        value:
          description: The value of this remote configuration
          oneOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: object
        valueType:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationValueType'
          description: The type of the value
        version:
          description: The version of the document for optimistic locking
          example: 1
          type: number
      required:
        - key
        - valueType
        - value
        - groups
        - id
        - version
        - flattenScopeIds
      title: RemoteConfiguration
      type: object
      description: RemoteConfiguration
    RemoteConfigurationForCreation:
      properties:
        groups:
          description: Groups this configuration belongs to
          example:
            - INVENTORY
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        key:
          description: Unique business key of this entity
          example: PICKING_SHOW_NEW_SCAN_VIEW
          type: string
        scopes:
          description: Scopes for this remote configuration
          items:
            $ref: '#/components/schemas/RemoteConfigurationScopeForCreation'
          maxItems: 20
          type: array
        value:
          description: The value of this remote configuration
          oneOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: object
        valueType:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationValueType'
          description: The type of the value
      required:
        - key
        - valueType
        - value
        - groups
      title: RemoteConfigurationForCreation
      type: object
      description: RemoteConfigurationForCreation
    RemoteConfigurationForPut:
      properties:
        groups:
          description: Groups this configuration belongs to
          example:
            - INVENTORY
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        scopes:
          description: Scopes for this remote configuration
          items:
            $ref: '#/components/schemas/RemoteConfigurationScopeForCreation'
          maxItems: 20
          type: array
        value:
          description: The value of this remote configuration
          oneOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: object
        valueType:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationValueType'
          description: The type of the value
        version:
          description: The version of the document for optimistic locking
          example: 1
          type: number
      required:
        - version
        - valueType
        - value
        - groups
      title: RemoteConfigurationForPut
      type: object
      description: RemoteConfigurationForPut
    RemoteConfigurationForUpdate:
      properties:
        groups:
          description: Groups this configuration belongs to
          example:
            - INVENTORY
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        scopes:
          description: Scopes for this remote configuration
          items:
            $ref: '#/components/schemas/RemoteConfigurationScopeForCreation'
          maxItems: 20
          type: array
        value:
          description: The value of this remote configuration
          oneOf:
            - type: string
            - type: integer
            - type: number
            - type: boolean
            - type: object
        valueType:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationValueType'
          description: The type of the value
        version:
          description: The version of the document for optimistic locking
          example: 1
          type: number
      required:
        - version
      title: RemoteConfigurationForUpdate
      type: object
      description: RemoteConfigurationForUpdate
    RemoteConfigurationPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        remoteConfigurations:
          items:
            $ref: '#/components/schemas/RemoteConfiguration'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - remoteConfigurations
      title: RemoteConfigurationPaginatedResult
      type: object
      description: RemoteConfigurationPaginatedResult
    RemoteConfigurations:
      properties:
        remoteConfigurations:
          description: Array of remote configurations
          items:
            $ref: '#/components/schemas/RemoteConfiguration'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: number
      title: RemoteConfigurations
      type: object
      description: RemoteConfigurations
    RemoteConfigurationScope:
      properties:
        facilityRefs:
          description: References of facilities this scope applies to
          example:
            - 928f3730-bc48-4d85-b83f-3fd86b776178
          items:
            type: string
          maxItems: 100
          type: array
        id:
          description: Auto generated unique identifier
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        userRefs:
          description: References of users this scope applies to
          example:
            - 928f3730-bc48-4d85-b83f-3fd86b776178
          items:
            type: string
          maxItems: 100
          type: array
      required:
        - id
      title: RemoteConfigurationScope
      type: object
      description: RemoteConfigurationScope
    RemoteConfigurationScopeForCreation:
      properties:
        facilityRefs:
          description: References of facilities this scope applies to
          example:
            - 928f3730-bc48-4d85-b83f-3fd86b776178
          items:
            type: string
          maxItems: 100
          type: array
        userRefs:
          description: References of users this scope applies to
          example:
            - 928f3730-bc48-4d85-b83f-3fd86b776178
          items:
            type: string
          maxItems: 100
          type: array
      title: RemoteConfigurationScopeForCreation
      type: object
      description: RemoteConfigurationScopeForCreation
    RemoteConfigurationScopesFilter:
      properties:
        facilityRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by facilityRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        userRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by userRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
      title: RemoteConfigurationScopesFilter
      type: object
      description: RemoteConfigurationScopesFilter
    RemoteConfigurationScopesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationScopesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RemoteConfigurationScopesListFilter
      type: object
      description: RemoteConfigurationScopesListFilter
    RemoteConfigurationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/RemoteConfigurationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: RemoteConfigurationSearchPayload
      type: object
      description: RemoteConfigurationSearchPayload
    RemoteConfigurationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/RemoteConfigurationSearchQuery'
          maxItems: 500
          type: array
        groups:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by groups
        key:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by key
        or:
          items:
            $ref: '#/components/schemas/RemoteConfigurationSearchQuery'
          maxItems: 500
          type: array
        scopes:
          allOf:
            - $ref: '#/components/schemas/RemoteConfigurationScopesListFilter'
          description: Nested list search by scopes
      title: RemoteConfigurationSearchQuery
      type: object
      description: RemoteConfigurationSearchQuery
    RemoteConfigurationValueType:
      description: The type of the value
      enum:
        - BOOLEAN
        - STRING
        - JSON
        - NUMBER
        - INT
      title: RemoteConfigurationValueType
      type: string
    RemoveFacilitiesFromGroupActionParameter:
      properties:
        facilitiesToRemove:
          description: Array of facility references to remove from the group
          items:
            type: string
          maxItems: 200
          minItems: 1
          type: array
        name:
          description: The name of the action
          enum:
            - REMOVE_FACILITIES_FROM_GROUP
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: number
      required:
        - facilitiesToRemove
        - name
        - version
      title: RemoveFacilitiesFromGroupActionParameter
      type: object
      description: RemoveFacilitiesFromGroupActionParameter
    RemoveFacilitiesFromGroupVersionlessActionParameter:
      properties:
        facilitiesToRemove:
          description: Array of facility references to remove from the group
          items:
            type: string
          maxItems: 200
          minItems: 1
          type: array
        name:
          description: The name of the action
          enum:
            - VERSIONLESS_REMOVE_FACILITIES_FROM_GROUP
          type: string
      required:
        - facilitiesToRemove
        - name
      title: RemoveFacilitiesFromGroupVersionlessActionParameter
      type: object
      description: RemoveFacilitiesFromGroupVersionlessActionParameter
    RemoveFacilityCoordinatesActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractFacilityActionsParameter'
      description: Remove facility Coordinates.
      properties:
        name:
          enum:
            - REMOVE_FACILITY_COORDINATES
          type: string
      required:
        - name
        - version
      title: RemoveFacilityCoordinatesActionParameter
    RemoveLineItemFromPackingTargetContainer:
      additionalProperties: false
      description: Action to a remove a line item from a packing target container.
      properties:
        action:
          description: >-
            'Deprecated. Use /api/packjobs/{packJobId}/actions with
            MOVE_EACHES_TO_PACKING_TARGET_CONTAINER or
            MOVE_EACHES_TO_PACKING_SOURCE_CONTAINER instead'
          enum:
            - RemoveLineItemFromPackingTargetContainer
          type: string
        lineItemRef:
          description: Id of the PackLineItem you want to remove.
          type: string
      required:
        - action
        - lineItemRef
      title: RemoveLineItemFromPackingTargetContainer
      type: object
      xml:
        name: RemoveLineItemFromPackingTargetContainer
    RemovePickJobFromPickRun:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'RemovePickJobFromPickRun', because you want to remove
                a pickjob
              enum:
                - RemovePickJobFromPickRun
              type: string
            pickJobRef:
              description: PickJob reference of the PickJob you want to remove.
              type: string
          required:
            - action
            - pickJobRef
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use /api/pickruns/{pickRunId}/actions instead
      title: RemovePickJobFromPickRun
      xml:
        name: RemovePickJobFromPickRun
    RemoveServiceDataAvailableLineItemsActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS'
          enum:
            - REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS
          example: REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS
          type: string
        serviceDataAvailableLineItemIds:
          description: Ids of the service data available line items to be removed
          example:
            - 41d43211-g5a1-gg22-a716-ba095e30ds1d
          items:
            type: string
          maxItems: 50
          minItems: 1
          type: array
        serviceDataVersion:
          description: Version of the service data
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - serviceDataAvailableLineItemIds
        - serviceDataVersion
      title: RemoveServiceDataAvailableLineItemsActionParameter
      type: object
      description: RemoveServiceDataAvailableLineItemsActionParameter
    ReopenStowJobAction:
      description: Sets the status of the stowjob to OPEN
      properties:
        name:
          description: The name of the action that should be performed
          enum:
            - OPEN_STOW_JOB
          type: string
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
      title: ReopenStowJobAction
      type: object
    ReplaceCodesInPackingTargetContainer:
      additionalProperties: false
      description: Action to replace codes in packing target container.
      properties:
        action:
          description: >-
            Use ReplaceCodesInPackingTargetContainer to add a code to an
            existing packing container
          enum:
            - ReplaceCodesInPackingTargetContainer
          type: string
        codes:
          items:
            description: List of codes
            minItems: 1
            type: string
          type: array
      required:
        - action
      title: ReplaceCodesInPackingTargetContainer
      type: object
      xml:
        name: ReplaceCodesInPackingTargetContainer
    ReplaceLineItemsOnItemReturnJobActionParameter:
      properties:
        name:
          enum:
            - REPLACE_LINE_ITEMS_ON_ITEM_RETURN_JOB
          type: string
        notReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItemForCreation'
          maxItems: 20
          minItems: 0
          type: array
        returnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnJobLineItemForCreation'
          maxItems: 20
          minItems: 0
          type: array
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - version
        - name
      title: ReplaceLineItemsOnItemReturnJobActionParameter
      type: object
      description: ReplaceLineItemsOnItemReturnJobActionParameter
    ReplaceLoadUnitLineItems:
      properties:
        action:
          description: >-
            Use value 'ReplaceLoadUnitLineItems', because you want to replace
            load unit line items
          enum:
            - ReplaceLoadUnitLineItems
          type: string
        loadUnitLineItems:
          items:
            $ref: '#/components/schemas/LoadUnitLineItem'
          maxItems: 100
          type: array
      required:
        - action
        - loadUnitLineItems
      title: ReplaceLoadUnitLineItems
      type: object
      description: ReplaceLoadUnitLineItems
    ReplacePackingTargetContainerLineItemCodesAction:
      additionalProperties: false
      description: Action to replace packing target container codes of a line item.
      properties:
        name:
          $ref: '#/components/schemas/ReplacePackingTargetContainerLineItemCodesEnum'
        payload:
          additionalProperties: false
          properties:
            codes:
              items:
                description: List of codes
                minItems: 1
                type: string
              type: array
          required:
            - codes
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - payload
        - version
        - name
      title: ReplacePackingTargetContainerLineItemCodesAction
      type: object
    ReplacePackingTargetContainerLineItemCodesEnum:
      enum:
        - ReplaceLineItemCodes
      type: string
      title: ReplacePackingTargetContainerLineItemCodesEnum
      description: ReplacePackingTargetContainerLineItemCodesEnum
    ReplaceReturnedLineItems:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        returnedLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemForCreation'
          maxItems: 100
          minItems: 1
          type: array
      required:
        - itemReturnJobVersion
        - returnedLineItems
      title: ReplaceReturnedLineItems
      type: object
      description: ReplaceReturnedLineItems
    ReplaceReturnedNotReturnableLineItems:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        returnedNotReturnableLineItems:
          items:
            $ref: '#/components/schemas/ItemReturnLineItemForCreation'
          maxItems: 100
          minItems: 1
          type: array
      required:
        - itemReturnJobVersion
        - returnedNotReturnableLineItems
      title: ReplaceReturnedNotReturnableLineItems
      type: object
      description: ReplaceReturnedNotReturnableLineItems
    RequestedDate:
      properties:
        type:
          enum:
            - ASAP
            - TIME_POINT
          type: string
        value:
          format: date-time
          type: string
      required:
        - type
        - value
      title: RequestedDate
      type: object
      description: RequestedDate
    RequestedDateASAP:
      properties:
        type:
          enum:
            - ASAP
            - TIME_POINT
          type: string
      required:
        - type
      title: RequestedDateASAP
      type: object
      description: RequestedDateASAP
    RequestedDateTimePoint:
      properties:
        type:
          enum:
            - ASAP
            - TIME_POINT
          type: string
        value:
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      required:
        - type
        - value
      title: RequestedDateTimePoint
      type: object
      description: RequestedDateTimePoint
    RequestLabelAction:
      properties:
        name:
          description: Identifier of the specified action.
          type: string
        version:
          description: Optimistic locking version
          example: 1
          type: integer
      required:
        - name
        - version
      title: RequestLabelAction
      type: object
      description: RequestLabelAction
    RequiredLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceDataItemArticle'
          description: Article information of the required item
        assignedItems:
          description: >-
            line items that have been assigned from the matching service data
            object
          items:
            $ref: '#/components/schemas/AssignedRequiredLineItem'
          maxItems: 50
          type: array
        id:
          description: Unique ID of the required line item
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: Needed quantity of the items
          example: 12
          minimum: 1
          type: integer
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          example:
            - '123456789012'
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 1
          minimum: 0
          type: number
      required:
        - id
        - article
        - quantity
      title: RequiredLineItem
      type: object
      description: RequiredLineItem
    RequiredLineItemForCreation:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceDataItemArticle'
          description: Article information of the required item
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: Needed quantity of the items
          example: 12
          minimum: 1
          type: integer
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          example:
            - '123456789012'
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 1
          minimum: 0
          type: number
      required:
        - article
        - quantity
      title: RequiredLineItemForCreation
      type: object
      description: RequiredLineItemForCreation
    RerouteConfiguration:
      properties:
        active:
          type: boolean
        leadTimeBeforeTimeTriggeredReroute:
          deprecated: true
          description: This setting is not supported anymore
          example: '480'
          minimum: 1
          type: number
        rerouteAfterMinutes:
          default: 1440
          description: The amount of minutes after which an automated reroute is executed
          example: '60'
          minimum: 5
          type: number
        rerouteStartedJobs:
          $ref: '#/components/schemas/RerouteStartedJobsConfiguration'
        rerouteTargetTimeHours:
          default: 48
          description: >-
            Only pickjobs within the target time window are considered for
            reroute.
          example: '48'
          minimum: 1
          type: number
      required:
        - active
        - rerouteTargetTimeHours
        - rerouteAfterMinutes
      title: RerouteConfiguration
      description: RerouteConfiguration
    RerouteDescription:
      allOf:
        - $ref: '#/components/schemas/AbstractReason'
      properties:
        action:
          enum:
            - REROUTE
          type: string
      required:
        - action
      type: object
      xml:
        name: RerouteDescription
      title: RerouteDescription
      description: RerouteDescription
    RerouteDescriptionForCreation:
      allOf:
        - $ref: '#/components/schemas/AbstractReasonForCreation'
      type: object
      xml:
        name: RerouteDescriptionForCreation
      title: RerouteDescriptionForCreation
      description: RerouteDescriptionForCreation
    RerouteDescriptionForModification:
      allOf:
        - $ref: '#/components/schemas/AbstractReasonForModification'
      type: object
      xml:
        name: RerouteDescriptionForModification
      title: RerouteDescriptionForModification
      description: RerouteDescriptionForModification
    RerouteDescriptionHistoryLog:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        id:
          type: string
        reason:
          type: string
        version:
          type: number
      required:
        - id
        - version
      type: object
      title: RerouteDescriptionHistoryLog
      description: RerouteDescriptionHistoryLog
    RerouteDescriptions:
      allOf:
        - $ref: '#/components/schemas/AbstractReasons'
      properties:
        reasons:
          items:
            $ref: '#/components/schemas/RerouteDescription'
          type: array
        rerouteDescriptions:
          items:
            $ref: '#/components/schemas/RerouteDescription'
          type: array
      required:
        - reasons
        - rerouteDescriptions
      type: object
      title: RerouteDescriptions
      description: RerouteDescriptions
    RerouteLogPayload:
      properties:
        rerouteDescription:
          $ref: '#/components/schemas/RerouteDescriptionHistoryLog'
        targetFacility:
          $ref: '#/components/schemas/ProcessHistoryLogFacility'
      required:
        - targetFacility
      type: object
      title: RerouteLogPayload
      description: RerouteLogPayload
    RerouteLogPayloadBase:
      properties:
        rerouteDescription:
          $ref: '#/components/schemas/RerouteDescriptionHistoryLog'
      type: object
      title: RerouteLogPayloadBase
      description: RerouteLogPayloadBase
    RerouteReason:
      enum:
        - ORDERMODIFIED
        - PROCESSREROUTE
        - MANUAL
        - SHORTPICK
        - TIMETRIGGERED
        - STOCKZEROED
        - ABORTED
        - RECALCULATION
      type: string
      title: RerouteReason
      description: RerouteReason
    RerouteRoutingPlan:
      properties:
        allReroutable:
          description: >-
            if set to true every reroutable routing plan is rerouted. overrules
            every other identifier
          type: boolean
        orderRefs:
          items:
            type: string
          maxItems: 10
          type: array
        routingPlanIds:
          items:
            type: string
          maxItems: 10
          type: array
        tenantOrderIds:
          items:
            type: string
          maxItems: 10
          type: array
      type: object
      title: RerouteRoutingPlan
      description: RerouteRoutingPlan
    RerouteShortPickConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      description: Reroute ShortPick Configuration
      properties:
        blacklistAssignedFacilities:
          default: false
          description: >-
            Does not consider facilities which previously owned the pickjob
            during routing.
          type: boolean
        clickAndCollectReroute:
          $ref: '#/components/schemas/ClickAndCollectRerouteConfiguration'
        id:
          type: string
        rerouteZeroPicksOnly:
          default: false
          description: >-
            Specifies whether only pick jobs with zero items picked are eligible
            for rerouting.
          type: boolean
        restowAfterMinutes:
          description: The amount of minutes after which an automated restow is executed
          example: '60'
          type: number
        shipFromStoreReroute:
          $ref: '#/components/schemas/ShipFromStoreRerouteConfiguration'
      required:
        - clickAndCollectReroute
        - shipFromStoreReroute
      title: RerouteShortPickConfiguration
      type: object
    RerouteStartedJobsConfiguration:
      properties:
        active:
          default: false
          description: >-
            If true, the reroute will be executed for jobs that are already
            started.
          example: true
          type: boolean
        minimumStartedTimeInMinutes:
          description: >-
            The minimum time in minutes that a job must be in a started status
            (eg. PAUSED, IN_PROGRESS) before it should be rerouted. This is to
            ensure that jobs are not rerouted too quickly after they have last
            been modified. Minimum value is 60 minutes.
          example: '60'
          minimum: 60
          type: number
      required:
        - active
      title: RerouteStartedJobsConfiguration
      description: RerouteStartedJobsConfiguration
    RerouteTimeTriggeredConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clickAndCollectReroute:
          $ref: '#/components/schemas/RerouteConfiguration'
        id:
          type: string
        shipFromStoreDeliveryReroute:
          $ref: '#/components/schemas/RerouteConfiguration'
        shipFromStoreSamedayReroute:
          $ref: '#/components/schemas/RerouteConfiguration'
      required:
        - clickAndCollectReroute
        - shipFromStoreDeliveryReroute
        - shipFromStoreSamedayReroute
      title: RerouteTimeTriggeredConfiguration
      description: RerouteTimeTriggeredConfiguration
    RerouteType:
      description: |-
        The type of reroute to apply to the order
          * `REROUTE`- the complete routing plan is rerouted.
          * `ORDERSPLIT`- the order is splitted. The short picked line items will be moved to a new routing plan and rerouted
      enum:
        - REROUTE
        - ORDERSPLIT
      type: string
      title: RerouteType
    Reservation:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        host:
          $ref: '#/components/schemas/ReservationHost'
        id:
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        quantity:
          type: number
        relatedRefs:
          allOf:
            - $ref: '#/components/schemas/RelatedRefs'
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        tenantArticleId:
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - facilityRef
        - host
        - id
        - quantity
        - relatedRefs
        - tenantArticleId
      title: Reservation
      type: object
      description: Reservation
    ReservationAction:
      properties:
        name:
          description: Which action to perform
          enum:
            - REMOVE_RESERVATIONS_REDUCE_STOCKS
            - REMOVE_RESERVATIONS_KEEP_STOCKS
          type: string
        reservationSelector:
          allOf:
            - $ref: '#/components/schemas/ReservationActionSelector'
          minProperties: 1
      required:
        - name
        - reservationSelector
      title: ReservationAction
      type: object
      description: ReservationAction
    ReservationActionResult:
      properties:
        reservation:
          $ref: '#/components/schemas/StrippedReservation'
        status:
          enum:
            - DELETED
          type: string
        stockOperations:
          items:
            $ref: '#/components/schemas/ReservationActionStockOperation'
          type: array
      required:
        - status
        - reservation
      title: ReservationActionResult
      type: object
      description: ReservationActionResult
    ReservationActionSelector:
      properties:
        orderRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        reservationPredicate:
          $ref: '#/components/schemas/ReservationSearchQuery'
        reservationRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 100
          minItems: 1
          type: array
        routingPlanRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        tenantOrderIds:
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
      title: ReservationActionSelector
      type: object
      description: ReservationActionSelector
    ReservationActionStockOperation:
      properties:
        status:
          enum:
            - REDUCED
            - DELETED
          type: string
        stock:
          $ref: '#/components/schemas/ReservationStock'
      required:
        - status
        - stock
      title: ReservationActionStockOperation
      type: object
      description: ReservationActionStockOperation
    ReservationHost:
      properties:
        reference:
          type: string
        type:
          enum:
            - STOCK
            - EXPECTED_STOCK
            - NONE
          type: string
      required:
        - reference
        - type
      title: ReservationHost
      type: object
      description: ReservationHost
    ReservationPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        reservations:
          items:
            $ref: '#/components/schemas/Reservation'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - reservations
      title: ReservationPaginatedResult
      type: object
      description: ReservationPaginatedResult
    ReservationRelatedRefsFilter:
      properties:
        orderRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by orderRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        pickJobRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by pickJobRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        routingPlanRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by routingPlanRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        transferRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by transferRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
      title: ReservationRelatedRefsFilter
      type: object
      description: ReservationRelatedRefsFilter
    ReservationReleaseCompletionEntityEnum:
      enum:
        - HANDOVERJOB
        - PICKJOB
      type: string
      title: ReservationReleaseCompletionEntityEnum
      description: ReservationReleaseCompletionEntityEnum
    ReservationsBulkWebHookEvent:
      properties:
        payload:
          $ref: '#/components/schemas/ReservationsBulkWebHookEventPayload'
      required:
        - payload
      title: ReservationsBulkWebHookEvent
      type: object
      description: ReservationsBulkWebHookEvent
    ReservationsBulkWebHookEventPayload:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Reservation'
          type: array
      required:
        - items
      title: ReservationsBulkWebHookEventPayload
      type: object
      description: ReservationsBulkWebHookEventPayload
    ReservationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ReservationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ReservationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ReservationSearchPayload
      type: object
      description: ReservationSearchPayload
    ReservationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ReservationSearchQuery'
          maxItems: 500
          type: array
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/ReservationSearchQuery'
          maxItems: 500
          type: array
        relatedRefs:
          allOf:
            - $ref: '#/components/schemas/ReservationRelatedRefsFilter'
          description: Nested search by relatedRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
      title: ReservationSearchQuery
      type: object
      description: ReservationSearchQuery
    ReservationSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: ReservationSort
      type: object
      description: ReservationSort
    ReservationsPaginatedResult:
      properties:
        pageInfo:
          $ref: '#/components/schemas/PageInfo'
        reservations:
          items:
            $ref: '#/components/schemas/Reservation'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - pageInfo
        - reservations
      title: ReservationsPaginatedResult
      type: object
      description: ReservationsPaginatedResult
    ReservationStock:
      properties:
        id:
          type: string
        version:
          type: number
      required:
        - id
        - version
      title: ReservationStock
      type: object
      description: ReservationStock
    ResetPickJob:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ResetPickJob' to reset the pickJob and set it back to
                status OPEN and reset the pick line items.
              enum:
                - ResetPickJob
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/pickjobs/:id/actions instead
      title: ResetPickJob
      xml:
        name: ResetPickJob
    ResolvedSubstitutes:
      properties:
        substitutes:
          items:
            $ref: '#/components/schemas/Substitute'
          type: array
        tenantArticleId:
          type: string
      required:
        - substitutes
        - tenantArticleId
      type: object
      xml:
        name: ResolvedSubstitutes
      title: ResolvedSubstitutes
      description: ResolvedSubstitutes
    ResourceInvestment:
      description: How much resources should be invested during the optimization?
      properties:
        level:
          description: >-
            [abstract values]: how many resources should we invest in
            optimization. With a higher level the results will be better,
            nevertheless we need to invest more time for the optimization.
          example: 0.2
          exclusiveMinimum: true
          maximum: 1
          minimum: 0
          type: number
      required:
        - level
      type: object
      title: ResourceInvestment
    ResponseForCNCCheckoutOptions:
      properties:
        facilities:
          description: Facilities offering Click & Collect (CNC)
          items:
            $ref: '#/components/schemas/CheckoutOptionsFacilityForCNC'
          type: array
      required:
        - facilities
      title: ResponseForCNCCheckoutOptions
      type: object
      description: ResponseForCNCCheckoutOptions
    ResponseForDeliveryPromise:
      additionalProperties: false
      properties:
        backOrdered:
          $ref: '#/components/schemas/Backordered'
        collect:
          $ref: '#/components/schemas/DeliveryPromiseCollect'
        orderRef:
          type: string
        orderVersion:
          type: number
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
        shipToCustomer:
          items:
            $ref: '#/components/schemas/DeliveryPromiseShipment'
          type: array
        shipToStore:
          items:
            $ref: '#/components/schemas/DeliveryPromiseShipment'
          type: array
        sourcingOption:
          $ref: '#/components/schemas/SourcingOption'
      required:
        - orderRef
        - orderVersion
      type: object
      xml:
        name: ResponseForDeliveryPromise
      title: ResponseForDeliveryPromise
      description: ResponseForDeliveryPromise
    ResponseForSFSCheckoutOptions:
      properties:
        facilities:
          description: Facilities offering Ship From Store (SFS)
          items:
            $ref: '#/components/schemas/CheckoutOptionsFacilityForSFS'
          type: array
      required:
        - facilities
      title: ResponseForSFSCheckoutOptions
      type: object
      description: ResponseForSFSCheckoutOptions
    RestartItemReturnJobActionParameter:
      properties:
        name:
          enum:
            - RestartItemReturnJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - version
        - name
      title: RestartItemReturnJobActionParameter
      type: object
      description: RestartItemReturnJobActionParameter
    RestartPickJob:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'RestartPickJob' to restart the pickJob and set it
                back to status IN_PROGRESS.
              enum:
                - RestartPickJob
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/pickjobs/:id/actions instead
      title: RestartPickJob
      xml:
        name: RestartPickJob
    RestartPickJobConfiguration:
      properties:
        active:
          default: true
          type: boolean
      required:
        - active
      type: object
      title: RestartPickJobConfiguration
      description: RestartPickJobConfiguration
    RestowAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      title: RestowAttributeItem
      description: RestowAttributeItem
    RestowedItems:
      properties:
        restowedItems:
          items:
            $ref: '#/components/schemas/RestowItem'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: RestowedItems
      description: RestowedItems
    RestowingProcessConfiguration:
      properties:
        restowingProcessTypes:
          items:
            $ref: '#/components/schemas/RestowingProcessTypeEnum'
          minItems: 0
          type: array
      required:
        - restowingProcessTypes
      type: object
      title: RestowingProcessConfiguration
      description: RestowingProcessConfiguration
    RestowingProcessTypeEnum:
      description: Where restow items should be created during the operational process
      enum:
        - PICKING
        - PACKING
        - HANDOVER
      type: string
      title: RestowingProcessTypeEnum
    RestowItem:
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItem'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        article:
          $ref: '#/components/schemas/RestowItemArticle'
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        id:
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        location:
          $ref: '#/components/schemas/Location'
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        operativeProcessRef:
          description: id of the connected operative process if available
          type: string
        processRef:
          description: id of the connected process if available
          type: string
        quantity:
          default: 1
          example: 1
          format: int64
          minimum: 1
          type: integer
        restowed:
          default: false
          description: Indicates if the restowItem has been restowed
          example: true
          type: boolean
        status:
          $ref: '#/components/schemas/RestowItemStatus'
        stockRef:
          description: id of the stock entity for this line item
          type: string
      required:
        - id
        - article
        - restowed
        - facilityRef
        - quantity
        - status
      type: object
      title: RestowItem
      description: RestowItem
    RestowItemActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/RestowItemRestowActionParameter'
        - $ref: '#/components/schemas/RestowItemCancelActionParameter'
      title: RestowItemActionsParameter
      description: RestowItemActionsParameter
    RestowItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/RestowAttributeItem'
              type: array
          type: object
      xml:
        name: RestowItemArticle
      title: RestowItemArticle
      description: RestowItemArticle
    RestowItemCancelActionEnum:
      enum:
        - CANCEL
      type: string
      title: RestowItemCancelActionEnum
      description: RestowItemCancelActionEnum
    RestowItemCancelActionParameter:
      additionalProperties: false
      description: Action to cancel a RestowItem.
      properties:
        name:
          $ref: '#/components/schemas/RestowItemCancelActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: RestowItemCancelActionParameter
    RestowItemForCreation:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/MandatoryLineItemForCreation'
      properties:
        article:
          $ref: '#/components/schemas/RestowItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        location:
          $ref: '#/components/schemas/Location'
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        quantity:
          default: 1
          example: 1
          format: int64
          minimum: 1
          type: integer
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          nullable: true
          type: array
        restowed:
          default: false
          description: Indicates if the restowItem has been restowed
          example: true
          type: boolean
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
      required:
        - facilityRef
        - article
        - quantity
      type: object
      title: RestowItemForCreation
      description: RestowItemForCreation
    RestowItemPatchActions:
      description: >-
        Deprecated Actions to modify restow items - please use
        /api/restowitem/{id}/actions
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyRestowItemAction'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      title: RestowItemPatchActions
      type: object
      xml:
        name: RestowItemPatchActions
    RestowItemRestowActionEnum:
      enum:
        - RESTOW
      type: string
      title: RestowItemRestowActionEnum
      description: RestowItemRestowActionEnum
    RestowItemRestowActionParameter:
      additionalProperties: false
      description: Action to restow a RestowItem.
      properties:
        location:
          $ref: '#/components/schemas/Location'
        name:
          $ref: '#/components/schemas/RestowItemRestowActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: RestowItemRestowActionParameter
    RestowItemsSortOptionsEnum:
      enum:
        - CREATED_DESC
        - CREATED_ASC
        - LAST_MODIFIED_DESC
        - LAST_MODIFIED_ASC
      type: string
      title: RestowItemsSortOptionsEnum
      description: RestowItemsSortOptionsEnum
    RestowItemStatus:
      description: Status of the restow item
      enum:
        - CANCELED
        - CLOSED
        - OPEN
      type: string
      title: RestowItemStatus
    ReturnConfiguration:
      properties:
        active:
          default: true
          deprecated: true
          description: >-
            Enable or disable legacy returns. Use returnTypeConfiguration
            instead
          example: true
          type: boolean
        allowTriggerRefund:
          default: false
          description: >-
            If true, a refund can be triggered. If false, the endpoints to
            trigger a refund are disabled.
          type: boolean
        availableDecisionReasons:
          items:
            $ref: '#/components/schemas/AvailableDecisionReasons'
          maxItems: 100
          type: array
        availableItemConditions:
          items:
            $ref: '#/components/schemas/AvailableItemCondition'
          type: array
        availableReturnReasons:
          items:
            $ref: '#/components/schemas/AvailableReturnReason'
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        returnTypeConfiguration:
          $ref: '#/components/schemas/ReturnTypeConfiguration'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 1
          type: integer
      required:
        - active
        - version
      title: ReturnConfiguration
      type: object
      description: ReturnConfiguration
    ReturnedLineItemRefund:
      properties:
        percent:
          description: 0.0 - 100.0 amount of the line item price that should be refunded
          example: 80.6
          maximum: 100
          minimum: 0
          type: number
        price:
          allOf:
            - $ref: '#/components/schemas/ReturnedLineItemRefundPrice'
          description: Either price or percent must be set, not both.
        status:
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
          type: string
      required:
        - status
      title: ReturnedLineItemRefund
      type: object
      description: ReturnedLineItemRefund
    ReturnedLineItemRefundPrice:
      additionalProperties: false
      properties:
        currency:
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
          description: The currency of the price as an ISO 4217 code.
          example: EUR
        value:
          description: 0.0 till line item price that should be refunded
          example: 20.55
          type: number
      required:
        - value
        - currency
      title: ReturnedLineItemRefundPrice
      description: ReturnedLineItemRefundPrice
    ReturnManagementPayloadBase:
      properties:
        facility:
          $ref: '#/components/schemas/ProcessHistoryLogFacility'
        itemReturnJobsRef:
          type: string
        shortId:
          type: string
      type: object
      title: ReturnManagementPayloadBase
      description: ReturnManagementPayloadBase
    ReturnManagementReturnPayload:
      allOf:
        - $ref: '#/components/schemas/ReturnManagementPayloadBase'
      properties:
        itemReturn:
          properties:
            id:
              type: string
            returnedLineItems:
              items:
                type: object
              type: array
            status:
              type: string
          type: object
      type: object
      title: ReturnManagementReturnPayload
      description: ReturnManagementReturnPayload
    ReturnNote:
      properties:
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        deliveryAddress:
          $ref: '#/components/schemas/DeliveryAddress'
        deliveryAddresses:
          description: >-
            if this field is filled, the delivery address will be taken from
            here according to this sorting: INVOICE_ADDRESS > POSTAL_ADDRESS.
            Each type is only allowed once.
          items:
            $ref: '#/components/schemas/DeliveryAddressWithType'
          type: array
        items:
          items:
            $ref: '#/components/schemas/ReturnNoteItem'
          type: array
        orderInformation:
          $ref: '#/components/schemas/OrderInformation'
        qrCodeContent:
          type: string
      required:
        - orderInformation
        - items
      type: object
      title: ReturnNote
      description: ReturnNote
    ReturnNoteConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      description: Return Note Configuration
      properties:
        articleIdLabel:
          $ref: '#/components/schemas/LocaleString'
        articleTitleLabel:
          $ref: '#/components/schemas/LocaleString'
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        disclaimer:
          $ref: '#/components/schemas/LocaleString'
        disclaimerHeadline:
          $ref: '#/components/schemas/LocaleString'
        displayPageLabel:
          default: false
          description: Determines if the page label should be shown
          type: boolean
        headline:
          $ref: '#/components/schemas/LocaleString'
        id:
          example: delivery-note
          type: string
        logoUrl:
          type: string
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfiguration'
        quantityLabel:
          $ref: '#/components/schemas/LocaleString'
        reasons:
          deprecated: true
          description: Deprecated - use ReturnConfiguration.availableReturnReasons instead
          items:
            $ref: '#/components/schemas/LocaleString'
          type: array
        returnReasonExplanation:
          $ref: '#/components/schemas/LocaleString'
        returnReasonExplanationHeadline:
          $ref: '#/components/schemas/LocaleString'
        returnReasonLabel:
          $ref: '#/components/schemas/LocaleString'
        substituteText:
          $ref: '#/components/schemas/LocaleString'
      required:
        - id
        - orderDateLabel
        - orderNumberLabel
        - headline
        - quantityLabel
        - articleIdLabel
        - articleTitleLabel
        - returnReasonLabel
        - disclaimerHeadline
        - disclaimer
        - pageLabel
      title: ReturnNoteConfiguration
      type: object
    ReturnNoteConfigurationForUpsert:
      additionalProperties: false
      properties:
        articleIdLabel:
          $ref: '#/components/schemas/LocaleString'
        articleTitleLabel:
          $ref: '#/components/schemas/LocaleString'
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        disclaimer:
          $ref: '#/components/schemas/LocaleString'
        disclaimerHeadline:
          $ref: '#/components/schemas/LocaleString'
        displayPageLabel:
          default: false
          description: Determines if the page label should be shown
          type: boolean
        headline:
          $ref: '#/components/schemas/LocaleString'
        logo:
          $ref: '#/components/schemas/NamedFile'
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfigurationForUpsert'
        quantityLabel:
          $ref: '#/components/schemas/LocaleString'
        reasons:
          deprecated: true
          description: Deprecated - use ReturnConfiguration.availableReturnReasons instead
          items:
            $ref: '#/components/schemas/LocaleString'
          type: array
        returnReasonExplanation:
          $ref: '#/components/schemas/LocaleString'
        returnReasonExplanationHeadline:
          $ref: '#/components/schemas/LocaleString'
        returnReasonLabel:
          $ref: '#/components/schemas/LocaleString'
        substituteText:
          $ref: '#/components/schemas/LocaleString'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - orderDateLabel
        - orderNumberLabel
        - headline
        - quantityLabel
        - articleIdLabel
        - articleTitleLabel
        - returnReasonLabel
        - disclaimerHeadline
        - disclaimer
        - pageLabel
        - version
      type: object
      title: ReturnNoteConfigurationForUpsert
      description: ReturnNoteConfigurationForUpsert
    ReturnNoteItem:
      properties:
        id:
          type: string
        quantity:
          description: optional parameter for picked quantity of the given line item
          type: integer
        substitutes:
          description: Titel of the item which is substituted through this item
          type: string
        title:
          type: string
      required:
        - title
      type: object
      title: ReturnNoteItem
      description: ReturnNoteItem
    ReturnTypeConfiguration:
      properties:
        type:
          enum:
            - RETURN
            - ITEM_RETURN
          type: string
      required:
        - type
      title: ReturnTypeConfiguration
      type: object
      description: ReturnTypeConfiguration
    Role:
      properties:
        context:
          description: >-
            An array of context objects, each defining a type and its allowed
            values — if a type is omitted, access for that type is unrestricted;
            if included, access is limited to the specified values, and each
            type must appear at most once.
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contextLimitations:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contexts:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        created:
          description: The date when the role was created.
          format: date-time
          type: string
        customAttributes:
          description: >-
            The custom attributes of the role, which can be used to store
            additional information.
          type: object
        description:
          description: >-
            The description of the role, which provides more details about its
            purpose.
          maxLength: 100
          type: string
        displayName:
          description: >-
            The display name of the role, which is used for user interfaces and
            may differ from the name (defaults to name if not provided).
          maxLength: 50
          type: string
        lastModified:
          description: The date when the role was last modified.
          format: date-time
          type: string
        name:
          description: >-
            The name of the role, which must be unique and is used to identify
            the role.
          maxLength: 20
          minLength: 3
          type: string
        permissions:
          description: >-
            The permissions associated with the role, which define what actions
            the role can perform.
          items:
            enum:
              - USER_READ
              - USERS_READ
              - USER_WRITE
              - USER_MODIFY
              - CURRENT_USER_READ
              - CURRENT_USER_MODIFY
              - ROLE_READ
              - ROLE_WRITE
              - FACILITY_READ
              - FACILITY_WRITE
              - FACILITY_CREATE
              - FACILITY_DELETE
              - FACILITY_GROUP_READ
              - FACILITY_GROUP_WRITE
              - ORDER_READ
              - ORDER_WRITE
              - ORDER_FORCE_CANCEL
              - ORDER_UNLOCK
              - ORDER_CANCEL
              - ORDER_CONSUMER_WRITE
              - ORDER_CUSTOM_ATTRIBUTES_WRITE
              - ORDER_LINEITEM_WRITE
              - ORDER_TOTAL_READ
              - LINE_ITEM_PRICING_READ
              - LINE_ITEM_QUANTITY_INCREASE
              - LINE_ITEM_ADD
              - LINE_ITEM_QUANTITY_DECREASE
              - LINE_ITEM_DELETE
              - SIMULATION_ORDER_READ
              - SIMULATION_ORDER_WRITE
              - AUDIT_READ
              - NOTIFICATION_READ
              - NOTIFICATION_WRITE
              - EXPIRIES_READ
              - EXPIRIES_WRITE
              - CONFIG_READ
              - CONFIG_WRITE
              - ROUTING_CONFIG_READ
              - ROUTING_CONFIG_WRITE
              - PROMISES_CONFIG_READ
              - PROMISES_CONFIG_WRITE
              - OIDC_PROVIDERS_CONFIG_READ
              - OIDC_PROVIDERS_CONFIG_WRITE
              - LOCALE_WRITE
              - CARRIER_READ
              - CARRIER_WRITE
              - RETURN_WRITE
              - RETURN_READ
              - ROUTING_READ
              - ROUTING_WRITE
              - PARCEL_READ
              - PARCEL_WRITE
              - SHIPMENT_READ
              - SHIPMENT_WRITE
              - HANDOVERJOB_READ
              - HANDOVERJOB_WRITE
              - PICKJOB_READ
              - PICKJOB_WRITE
              - PICKJOB_REROUTE
              - REMOTE_CONFIG_READ
              - REMOTE_CONFIG_WRITE
              - PICKRUN_READ
              - PICKRUN_WRITE
              - LOADUNITTYPE_READ
              - LOADUNITTYPE_WRITE
              - LOADUNIT_READ
              - LOADUNIT_WRITE
              - MEASUREMENTUNIT_READ
              - MEASUREMENTUNIT_WRITE
              - EVENT_READ
              - SUBSCRIPTION_READ
              - SUBSCRIPTION_WRITE
              - SUBSTITUTE_READ
              - SUBSTITUTE_WRITE
              - PROCESS_READ
              - PROCESS_WRITE
              - PROCESS_REROUTE
              - EXTERNAL_ACTIONS_READ
              - EXTERNAL_ACTIONS_WRITE
              - PROCESS_LOG_READ
              - OPERATIVE_PROCESS_READ
              - OPERATIVE_PROCESS_WRITE
              - DELIVERYNOTE_WRITE
              - PACKJOB_READ
              - PACKJOB_WRITE
              - PACKINGCONTAINER_TYPE_WRITE
              - PACKING_SOURCE_CONTAINER_READ
              - PACKING_SOURCE_CONTAINER_WRITE
              - RESTOW_ITEM_READ
              - RESTOW_ITEM_WRITE
              - TAG_READ
              - TAG_WRITE
              - STOCK_READ
              - STOCK_WRITE
              - EXTERNAL_STOCK_CHANGE_REASONS_READ
              - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
              - STORAGE_LOCATION_READ
              - STORAGE_LOCATION_WRITE
              - STOW_JOB_READ
              - STOW_JOB_OPERATIVE_WRITE
              - STOW_JOB_FULL_WRITE
              - NOTIFICATION_CENTER_CONFIG_READ
              - NOTIFICATION_CENTER_CONFIG_WRITE
              - DOMS_TOOLKIT_READ
              - DOMS_TOOLKIT_WRITE
              - ANALYTICS_DASHBOARD_READ
              - DOCUMENT_SET_READ
              - DOCUMENT_SET_WRITE
              - INBOUND_PROCESS_READ
              - INBOUND_PROCESS_WRITE
              - ADMIN_DATA_RESET
              - ADMIN_MODULES_READ
              - ADMIN_MODULES_WRITE
              - TENANT_CONNECTOR_CONFIG_READ
              - CUSTOM_SERVICE_WRITE
              - CUSTOM_SERVICE_READ
              - VALIDATIONS_READ
              - SERVICE_JOB_READ
              - SERVICE_JOB_WRITE
              - LINKED_SERVICE_JOBS_READ
              - LINKED_SERVICE_JOBS_WRITE
              - OPERATION_STATISTICS_READ
              - DOMS_STATISTICS_READ
              - AVAILABILITY_CHANNEL_READ
              - AVAILABILITY_CHANNEL_WRITE
              - HANDOVER_CONTAINER_READ
              - HANDOVER_CONTAINER_WRITE
              - STACKS_READ
              - STACKS_WRITE
              - CATEGORY_READ
              - CATEGORY_WRITE
              - PERMISSION_READ
              - KPI_READ
              - AI_ASSISTANT_ACCESS
              - RESERVATION_WRITE
              - RESERVATION_READ
              - FILTER_ENTITY_READ
              - BRAND_READ
              - WORKFLOW_DEFINITION_READ
              - WORKFLOW_DEFINITION_WRITE
              - LOOKUP_RECORD_READ
              - LOOKUP_RECORD_WRITE
              - ORDER_RECORD_READ
              - ORDER_RECORD_WRITE
              - PACKAGING_UNITS_READ
              - PACKAGING_UNITS_WRITE
              - EXPORT_READ
              - EXPORT_WRITE
              - STOCK_AVAILABILITIES_READ
              - LISTING_READ
              - LISTING_WRITE
              - LISTING_DELETE
              - PURCHASE_PRICE_READ
              - ZONE_READ
              - ZONE_WRITE
              - SAFETY_STOCK_READ
              - SAFETY_STOCK_WRITE
            type: string
          maxItems: 500
          type: array
        version:
          description: The version of the role.
          example: 1
          type: number
      required:
        - name
        - permissions
        - version
        - created
        - lastModified
      title: Role
      type: object
      description: Role
    RoleForCreation:
      properties:
        context:
          description: >-
            An array of context objects, each defining a type and its allowed
            values — if a type is omitted, access for that type is unrestricted;
            if included, access is limited to the specified values, and each
            type must appear at most once.
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contextLimitations:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contexts:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        customAttributes:
          description: >-
            The custom attributes of the role, which can be used to store
            additional information.
          type: object
        description:
          description: >-
            The description of the role, which provides more details about its
            purpose.
          maxLength: 100
          type: string
        displayName:
          description: >-
            The display name of the role, which is used for user interfaces and
            may differ from the name (defaults to name if not provided).
          maxLength: 50
          type: string
        name:
          description: >-
            The name of the role, which must be unique and is used to identify
            the role.
          maxLength: 20
          minLength: 3
          type: string
        permissions:
          description: >-
            The permissions associated with the role, which define what actions
            the role can perform.
          items:
            enum:
              - USER_READ
              - USERS_READ
              - USER_WRITE
              - USER_MODIFY
              - CURRENT_USER_READ
              - CURRENT_USER_MODIFY
              - ROLE_READ
              - ROLE_WRITE
              - FACILITY_READ
              - FACILITY_WRITE
              - FACILITY_CREATE
              - FACILITY_DELETE
              - FACILITY_GROUP_READ
              - FACILITY_GROUP_WRITE
              - ORDER_READ
              - ORDER_WRITE
              - ORDER_FORCE_CANCEL
              - ORDER_UNLOCK
              - ORDER_CANCEL
              - ORDER_CONSUMER_WRITE
              - ORDER_CUSTOM_ATTRIBUTES_WRITE
              - ORDER_LINEITEM_WRITE
              - ORDER_TOTAL_READ
              - LINE_ITEM_PRICING_READ
              - LINE_ITEM_QUANTITY_INCREASE
              - LINE_ITEM_ADD
              - LINE_ITEM_QUANTITY_DECREASE
              - LINE_ITEM_DELETE
              - SIMULATION_ORDER_READ
              - SIMULATION_ORDER_WRITE
              - AUDIT_READ
              - NOTIFICATION_READ
              - NOTIFICATION_WRITE
              - EXPIRIES_READ
              - EXPIRIES_WRITE
              - CONFIG_READ
              - CONFIG_WRITE
              - ROUTING_CONFIG_READ
              - ROUTING_CONFIG_WRITE
              - PROMISES_CONFIG_READ
              - PROMISES_CONFIG_WRITE
              - OIDC_PROVIDERS_CONFIG_READ
              - OIDC_PROVIDERS_CONFIG_WRITE
              - LOCALE_WRITE
              - CARRIER_READ
              - CARRIER_WRITE
              - RETURN_WRITE
              - RETURN_READ
              - ROUTING_READ
              - ROUTING_WRITE
              - PARCEL_READ
              - PARCEL_WRITE
              - SHIPMENT_READ
              - SHIPMENT_WRITE
              - HANDOVERJOB_READ
              - HANDOVERJOB_WRITE
              - PICKJOB_READ
              - PICKJOB_WRITE
              - PICKJOB_REROUTE
              - REMOTE_CONFIG_READ
              - REMOTE_CONFIG_WRITE
              - PICKRUN_READ
              - PICKRUN_WRITE
              - LOADUNITTYPE_READ
              - LOADUNITTYPE_WRITE
              - LOADUNIT_READ
              - LOADUNIT_WRITE
              - MEASUREMENTUNIT_READ
              - MEASUREMENTUNIT_WRITE
              - EVENT_READ
              - SUBSCRIPTION_READ
              - SUBSCRIPTION_WRITE
              - SUBSTITUTE_READ
              - SUBSTITUTE_WRITE
              - PROCESS_READ
              - PROCESS_WRITE
              - PROCESS_REROUTE
              - EXTERNAL_ACTIONS_READ
              - EXTERNAL_ACTIONS_WRITE
              - PROCESS_LOG_READ
              - OPERATIVE_PROCESS_READ
              - OPERATIVE_PROCESS_WRITE
              - DELIVERYNOTE_WRITE
              - PACKJOB_READ
              - PACKJOB_WRITE
              - PACKINGCONTAINER_TYPE_WRITE
              - PACKING_SOURCE_CONTAINER_READ
              - PACKING_SOURCE_CONTAINER_WRITE
              - RESTOW_ITEM_READ
              - RESTOW_ITEM_WRITE
              - TAG_READ
              - TAG_WRITE
              - STOCK_READ
              - STOCK_WRITE
              - EXTERNAL_STOCK_CHANGE_REASONS_READ
              - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
              - STORAGE_LOCATION_READ
              - STORAGE_LOCATION_WRITE
              - STOW_JOB_READ
              - STOW_JOB_OPERATIVE_WRITE
              - STOW_JOB_FULL_WRITE
              - NOTIFICATION_CENTER_CONFIG_READ
              - NOTIFICATION_CENTER_CONFIG_WRITE
              - DOMS_TOOLKIT_READ
              - DOMS_TOOLKIT_WRITE
              - ANALYTICS_DASHBOARD_READ
              - DOCUMENT_SET_READ
              - DOCUMENT_SET_WRITE
              - INBOUND_PROCESS_READ
              - INBOUND_PROCESS_WRITE
              - ADMIN_DATA_RESET
              - ADMIN_MODULES_READ
              - ADMIN_MODULES_WRITE
              - TENANT_CONNECTOR_CONFIG_READ
              - CUSTOM_SERVICE_WRITE
              - CUSTOM_SERVICE_READ
              - VALIDATIONS_READ
              - SERVICE_JOB_READ
              - SERVICE_JOB_WRITE
              - LINKED_SERVICE_JOBS_READ
              - LINKED_SERVICE_JOBS_WRITE
              - OPERATION_STATISTICS_READ
              - DOMS_STATISTICS_READ
              - AVAILABILITY_CHANNEL_READ
              - AVAILABILITY_CHANNEL_WRITE
              - HANDOVER_CONTAINER_READ
              - HANDOVER_CONTAINER_WRITE
              - STACKS_READ
              - STACKS_WRITE
              - CATEGORY_READ
              - CATEGORY_WRITE
              - PERMISSION_READ
              - KPI_READ
              - AI_ASSISTANT_ACCESS
              - RESERVATION_WRITE
              - RESERVATION_READ
              - FILTER_ENTITY_READ
              - BRAND_READ
              - WORKFLOW_DEFINITION_READ
              - WORKFLOW_DEFINITION_WRITE
              - LOOKUP_RECORD_READ
              - LOOKUP_RECORD_WRITE
              - ORDER_RECORD_READ
              - ORDER_RECORD_WRITE
              - PACKAGING_UNITS_READ
              - PACKAGING_UNITS_WRITE
              - EXPORT_READ
              - EXPORT_WRITE
              - STOCK_AVAILABILITIES_READ
              - LISTING_READ
              - LISTING_WRITE
              - LISTING_DELETE
              - PURCHASE_PRICE_READ
              - ZONE_READ
              - ZONE_WRITE
              - SAFETY_STOCK_READ
              - SAFETY_STOCK_WRITE
            type: string
          maxItems: 500
          type: array
      required:
        - name
        - permissions
      title: RoleForCreation
      type: object
      description: RoleForCreation
    RoleForPatch:
      properties:
        context:
          description: >-
            An array of context objects, each defining a type and its allowed
            values — if a type is omitted, access for that type is unrestricted;
            if included, access is limited to the specified values, and each
            type must appear at most once.
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contextLimitations:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contexts:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        customAttributes:
          description: >-
            The custom attributes of the role, which can be used to store
            additional information.
          type: object
        description:
          description: >-
            The description of the role, which provides more details about its
            purpose.
          maxLength: 100
          type: string
        displayName:
          description: >-
            The display name of the role, which is used for user interfaces and
            may differ from the name (defaults to name if not provided).
          maxLength: 100
          type: string
        name:
          description: >-
            The name of the role, which must be unique and is used to identify
            the role.
          type: string
        permissions:
          description: >-
            The permissions associated with the role, which define what actions
            the role can perform.
          items:
            enum:
              - USER_READ
              - USERS_READ
              - USER_WRITE
              - USER_MODIFY
              - CURRENT_USER_READ
              - CURRENT_USER_MODIFY
              - ROLE_READ
              - ROLE_WRITE
              - FACILITY_READ
              - FACILITY_WRITE
              - FACILITY_CREATE
              - FACILITY_DELETE
              - FACILITY_GROUP_READ
              - FACILITY_GROUP_WRITE
              - ORDER_READ
              - ORDER_WRITE
              - ORDER_FORCE_CANCEL
              - ORDER_UNLOCK
              - ORDER_CANCEL
              - ORDER_CONSUMER_WRITE
              - ORDER_CUSTOM_ATTRIBUTES_WRITE
              - ORDER_LINEITEM_WRITE
              - ORDER_TOTAL_READ
              - LINE_ITEM_PRICING_READ
              - LINE_ITEM_QUANTITY_INCREASE
              - LINE_ITEM_ADD
              - LINE_ITEM_QUANTITY_DECREASE
              - LINE_ITEM_DELETE
              - SIMULATION_ORDER_READ
              - SIMULATION_ORDER_WRITE
              - AUDIT_READ
              - NOTIFICATION_READ
              - NOTIFICATION_WRITE
              - EXPIRIES_READ
              - EXPIRIES_WRITE
              - CONFIG_READ
              - CONFIG_WRITE
              - ROUTING_CONFIG_READ
              - ROUTING_CONFIG_WRITE
              - PROMISES_CONFIG_READ
              - PROMISES_CONFIG_WRITE
              - OIDC_PROVIDERS_CONFIG_READ
              - OIDC_PROVIDERS_CONFIG_WRITE
              - LOCALE_WRITE
              - CARRIER_READ
              - CARRIER_WRITE
              - RETURN_WRITE
              - RETURN_READ
              - ROUTING_READ
              - ROUTING_WRITE
              - PARCEL_READ
              - PARCEL_WRITE
              - SHIPMENT_READ
              - SHIPMENT_WRITE
              - HANDOVERJOB_READ
              - HANDOVERJOB_WRITE
              - PICKJOB_READ
              - PICKJOB_WRITE
              - PICKJOB_REROUTE
              - REMOTE_CONFIG_READ
              - REMOTE_CONFIG_WRITE
              - PICKRUN_READ
              - PICKRUN_WRITE
              - LOADUNITTYPE_READ
              - LOADUNITTYPE_WRITE
              - LOADUNIT_READ
              - LOADUNIT_WRITE
              - MEASUREMENTUNIT_READ
              - MEASUREMENTUNIT_WRITE
              - EVENT_READ
              - SUBSCRIPTION_READ
              - SUBSCRIPTION_WRITE
              - SUBSTITUTE_READ
              - SUBSTITUTE_WRITE
              - PROCESS_READ
              - PROCESS_WRITE
              - PROCESS_REROUTE
              - EXTERNAL_ACTIONS_READ
              - EXTERNAL_ACTIONS_WRITE
              - PROCESS_LOG_READ
              - OPERATIVE_PROCESS_READ
              - OPERATIVE_PROCESS_WRITE
              - DELIVERYNOTE_WRITE
              - PACKJOB_READ
              - PACKJOB_WRITE
              - PACKINGCONTAINER_TYPE_WRITE
              - PACKING_SOURCE_CONTAINER_READ
              - PACKING_SOURCE_CONTAINER_WRITE
              - RESTOW_ITEM_READ
              - RESTOW_ITEM_WRITE
              - TAG_READ
              - TAG_WRITE
              - STOCK_READ
              - STOCK_WRITE
              - EXTERNAL_STOCK_CHANGE_REASONS_READ
              - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
              - STORAGE_LOCATION_READ
              - STORAGE_LOCATION_WRITE
              - STOW_JOB_READ
              - STOW_JOB_OPERATIVE_WRITE
              - STOW_JOB_FULL_WRITE
              - NOTIFICATION_CENTER_CONFIG_READ
              - NOTIFICATION_CENTER_CONFIG_WRITE
              - DOMS_TOOLKIT_READ
              - DOMS_TOOLKIT_WRITE
              - ANALYTICS_DASHBOARD_READ
              - DOCUMENT_SET_READ
              - DOCUMENT_SET_WRITE
              - INBOUND_PROCESS_READ
              - INBOUND_PROCESS_WRITE
              - ADMIN_DATA_RESET
              - ADMIN_MODULES_READ
              - ADMIN_MODULES_WRITE
              - TENANT_CONNECTOR_CONFIG_READ
              - CUSTOM_SERVICE_WRITE
              - CUSTOM_SERVICE_READ
              - VALIDATIONS_READ
              - SERVICE_JOB_READ
              - SERVICE_JOB_WRITE
              - LINKED_SERVICE_JOBS_READ
              - LINKED_SERVICE_JOBS_WRITE
              - OPERATION_STATISTICS_READ
              - DOMS_STATISTICS_READ
              - AVAILABILITY_CHANNEL_READ
              - AVAILABILITY_CHANNEL_WRITE
              - HANDOVER_CONTAINER_READ
              - HANDOVER_CONTAINER_WRITE
              - STACKS_READ
              - STACKS_WRITE
              - CATEGORY_READ
              - CATEGORY_WRITE
              - PERMISSION_READ
              - KPI_READ
              - AI_ASSISTANT_ACCESS
              - RESERVATION_WRITE
              - RESERVATION_READ
              - FILTER_ENTITY_READ
              - BRAND_READ
              - WORKFLOW_DEFINITION_READ
              - WORKFLOW_DEFINITION_WRITE
              - LOOKUP_RECORD_READ
              - LOOKUP_RECORD_WRITE
              - ORDER_RECORD_READ
              - ORDER_RECORD_WRITE
              - PACKAGING_UNITS_READ
              - PACKAGING_UNITS_WRITE
              - EXPORT_READ
              - EXPORT_WRITE
              - STOCK_AVAILABILITIES_READ
              - LISTING_READ
              - LISTING_WRITE
              - LISTING_DELETE
              - PURCHASE_PRICE_READ
              - ZONE_READ
              - ZONE_WRITE
              - SAFETY_STOCK_READ
              - SAFETY_STOCK_WRITE
            type: string
          maxItems: 500
          type: array
        version:
          description: The version of the role.
          example: 1
          type: number
      required:
        - version
        - name
      title: RoleForPatch
      type: object
      description: RoleForPatch
    RoleForUpdate:
      properties:
        context:
          description: >-
            An array of context objects, each defining a type and its allowed
            values — if a type is omitted, access for that type is unrestricted;
            if included, access is limited to the specified values, and each
            type must appear at most once.
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contextLimitations:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        contexts:
          deprecated: true
          description: 'Deprecated: Use context instead.'
          items:
            $ref: '#/components/schemas/ContextLimitation'
          maxItems: 100
          type: array
        customAttributes:
          description: >-
            The custom attributes of the role, which can be used to store
            additional information.
          type: object
        description:
          description: >-
            The description of the role, which provides more details about its
            purpose.
          maxLength: 100
          type: string
        displayName:
          description: >-
            The display name of the role, which is used for user interfaces and
            may differ from the name (defaults to name if not provided).
          maxLength: 50
          type: string
        name:
          description: >-
            The name of the role, which must be unique and is used to identify
            the role.
          maxLength: 20
          minLength: 3
          type: string
        permissions:
          description: >-
            The permissions associated with the role, which define what actions
            the role can perform.
          items:
            enum:
              - USER_READ
              - USERS_READ
              - USER_WRITE
              - USER_MODIFY
              - CURRENT_USER_READ
              - CURRENT_USER_MODIFY
              - ROLE_READ
              - ROLE_WRITE
              - FACILITY_READ
              - FACILITY_WRITE
              - FACILITY_CREATE
              - FACILITY_DELETE
              - FACILITY_GROUP_READ
              - FACILITY_GROUP_WRITE
              - ORDER_READ
              - ORDER_WRITE
              - ORDER_FORCE_CANCEL
              - ORDER_UNLOCK
              - ORDER_CANCEL
              - ORDER_CONSUMER_WRITE
              - ORDER_CUSTOM_ATTRIBUTES_WRITE
              - ORDER_LINEITEM_WRITE
              - ORDER_TOTAL_READ
              - LINE_ITEM_PRICING_READ
              - LINE_ITEM_QUANTITY_INCREASE
              - LINE_ITEM_ADD
              - LINE_ITEM_QUANTITY_DECREASE
              - LINE_ITEM_DELETE
              - SIMULATION_ORDER_READ
              - SIMULATION_ORDER_WRITE
              - AUDIT_READ
              - NOTIFICATION_READ
              - NOTIFICATION_WRITE
              - EXPIRIES_READ
              - EXPIRIES_WRITE
              - CONFIG_READ
              - CONFIG_WRITE
              - ROUTING_CONFIG_READ
              - ROUTING_CONFIG_WRITE
              - PROMISES_CONFIG_READ
              - PROMISES_CONFIG_WRITE
              - OIDC_PROVIDERS_CONFIG_READ
              - OIDC_PROVIDERS_CONFIG_WRITE
              - LOCALE_WRITE
              - CARRIER_READ
              - CARRIER_WRITE
              - RETURN_WRITE
              - RETURN_READ
              - ROUTING_READ
              - ROUTING_WRITE
              - PARCEL_READ
              - PARCEL_WRITE
              - SHIPMENT_READ
              - SHIPMENT_WRITE
              - HANDOVERJOB_READ
              - HANDOVERJOB_WRITE
              - PICKJOB_READ
              - PICKJOB_WRITE
              - PICKJOB_REROUTE
              - REMOTE_CONFIG_READ
              - REMOTE_CONFIG_WRITE
              - PICKRUN_READ
              - PICKRUN_WRITE
              - LOADUNITTYPE_READ
              - LOADUNITTYPE_WRITE
              - LOADUNIT_READ
              - LOADUNIT_WRITE
              - MEASUREMENTUNIT_READ
              - MEASUREMENTUNIT_WRITE
              - EVENT_READ
              - SUBSCRIPTION_READ
              - SUBSCRIPTION_WRITE
              - SUBSTITUTE_READ
              - SUBSTITUTE_WRITE
              - PROCESS_READ
              - PROCESS_WRITE
              - PROCESS_REROUTE
              - EXTERNAL_ACTIONS_READ
              - EXTERNAL_ACTIONS_WRITE
              - PROCESS_LOG_READ
              - OPERATIVE_PROCESS_READ
              - OPERATIVE_PROCESS_WRITE
              - DELIVERYNOTE_WRITE
              - PACKJOB_READ
              - PACKJOB_WRITE
              - PACKINGCONTAINER_TYPE_WRITE
              - PACKING_SOURCE_CONTAINER_READ
              - PACKING_SOURCE_CONTAINER_WRITE
              - RESTOW_ITEM_READ
              - RESTOW_ITEM_WRITE
              - TAG_READ
              - TAG_WRITE
              - STOCK_READ
              - STOCK_WRITE
              - EXTERNAL_STOCK_CHANGE_REASONS_READ
              - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
              - STORAGE_LOCATION_READ
              - STORAGE_LOCATION_WRITE
              - STOW_JOB_READ
              - STOW_JOB_OPERATIVE_WRITE
              - STOW_JOB_FULL_WRITE
              - NOTIFICATION_CENTER_CONFIG_READ
              - NOTIFICATION_CENTER_CONFIG_WRITE
              - DOMS_TOOLKIT_READ
              - DOMS_TOOLKIT_WRITE
              - ANALYTICS_DASHBOARD_READ
              - DOCUMENT_SET_READ
              - DOCUMENT_SET_WRITE
              - INBOUND_PROCESS_READ
              - INBOUND_PROCESS_WRITE
              - ADMIN_DATA_RESET
              - ADMIN_MODULES_READ
              - ADMIN_MODULES_WRITE
              - TENANT_CONNECTOR_CONFIG_READ
              - CUSTOM_SERVICE_WRITE
              - CUSTOM_SERVICE_READ
              - VALIDATIONS_READ
              - SERVICE_JOB_READ
              - SERVICE_JOB_WRITE
              - LINKED_SERVICE_JOBS_READ
              - LINKED_SERVICE_JOBS_WRITE
              - OPERATION_STATISTICS_READ
              - DOMS_STATISTICS_READ
              - AVAILABILITY_CHANNEL_READ
              - AVAILABILITY_CHANNEL_WRITE
              - HANDOVER_CONTAINER_READ
              - HANDOVER_CONTAINER_WRITE
              - STACKS_READ
              - STACKS_WRITE
              - CATEGORY_READ
              - CATEGORY_WRITE
              - PERMISSION_READ
              - KPI_READ
              - AI_ASSISTANT_ACCESS
              - RESERVATION_WRITE
              - RESERVATION_READ
              - FILTER_ENTITY_READ
              - BRAND_READ
              - WORKFLOW_DEFINITION_READ
              - WORKFLOW_DEFINITION_WRITE
              - LOOKUP_RECORD_READ
              - LOOKUP_RECORD_WRITE
              - ORDER_RECORD_READ
              - ORDER_RECORD_WRITE
              - PACKAGING_UNITS_READ
              - PACKAGING_UNITS_WRITE
              - EXPORT_READ
              - EXPORT_WRITE
              - STOCK_AVAILABILITIES_READ
              - LISTING_READ
              - LISTING_WRITE
              - LISTING_DELETE
              - PURCHASE_PRICE_READ
              - ZONE_READ
              - ZONE_WRITE
              - SAFETY_STOCK_READ
              - SAFETY_STOCK_WRITE
            type: string
          maxItems: 500
          type: array
        version:
          description: The version of the role.
          example: 1
          type: number
      required:
        - name
        - permissions
        - version
      title: RoleForUpdate
      type: object
      description: RoleForUpdate
    RolePaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        roles:
          items:
            $ref: '#/components/schemas/Role'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - roles
      title: RolePaginatedResult
      type: object
      description: RolePaginatedResult
    RoleSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/RoleSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/RoleSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: RoleSearchPayload
      type: object
      description: RoleSearchPayload
    RoleSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/RoleSearchQuery'
          maxItems: 500
          type: array
        description:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by description
        displayName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by displayName
        name:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/RoleSearchQuery'
          maxItems: 500
          type: array
      title: RoleSearchQuery
      type: object
      description: RoleSearchQuery
    RoleSort:
      properties:
        displayName:
          enum:
            - ASC
            - DESC
          type: string
      title: RoleSort
      type: object
      description: RoleSort
    RoutingConfiguration:
      additionalProperties: false
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />This
        is the configuration for the distributing order management system. By
        changing the configuration you are able to change the behavior of the
        routing of orders henceforth.
      properties:
        created:
          description: >-
            The date this order was created at the platform. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        globalRoutingConfiguration:
          $ref: '#/components/schemas/GlobalRoutingConfiguration'
        id:
          type: string
        lastModified:
          description: >-
            The date this order was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        prioritizationRules:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated Contains the routing configuration for prioritization
            & routing for the whole tenant
          items:
            $ref: '#/components/schemas/PrioritizationRule'
          type: array
        routingRule:
          $ref: '#/components/schemas/RoutingRule'
        timingMode:
          $ref: '#/components/schemas/RoutingConfigurationTiming'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - prioritizationRules
        - routingRule
        - globalRoutingConfiguration
      type: object
      title: RoutingConfiguration
      x-badges:
        - color: orange
          label: BETA
    RoutingConfigurationsPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyFenceAction'
              - $ref: '#/components/schemas/ModifyRatingAction'
              - $ref: '#/components/schemas/ModifyTimingModeAction'
              - $ref: '#/components/schemas/ModifyOrderSplitAction'
              - $ref: '#/components/schemas/ModifyPrioritizationAction'
              - $ref: '#/components/schemas/ModifyGlobalRoutingConfigurationAction'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: RoutingConfigurationsPatchActions
      title: RoutingConfigurationsPatchActions
      description: RoutingConfigurationsPatchActions
    RoutingConfigurationTiming:
      description: Configuration for the timing of routing decisions
      properties:
        options:
          type: object
        type:
          $ref: '#/components/schemas/RoutingConfigurationTimingType'
      required:
        - type
      type: object
      title: RoutingConfigurationTiming
    RoutingConfigurationTimingType:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />The
        available types for routing timing.
      enum:
        - DIRECT
        - MANUAL
      type: string
      xml:
        name: RoutingConfigurationTimingType
      title: RoutingConfigurationTimingType
      x-badges:
        - color: orange
          label: BETA
    RoutingDecisionContext:
      enum:
        - LISTING
        - CARRIER
      title: RoutingDecisionContext
      description: RoutingDecisionContext
    RoutingDecisionLog:
      properties:
        created:
          description: >-
            The date this order was created at the platform. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        executionResults:
          $ref: '#/components/schemas/SourcingOptionsExecutionResults'
        id:
          type: string
        lastModified:
          description: >-
            The date this order was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        relatedRefs:
          $ref: '#/components/schemas/RoutingDecisionLogRelatedRefs'
        routingStrategyEvaluationResult:
          $ref: '#/components/schemas/RoutingStrategyEvaluationResult'
        sourcingOptions:
          items:
            $ref: '#/components/schemas/SourcingOption'
          type: array
      required:
        - id
        - created
        - lastModified
        - relatedRefs
        - sourcingOptions
        - executionResults
      type: object
      xml:
        name: RoutingDecisionLog
      title: RoutingDecisionLog
      description: RoutingDecisionLog
    RoutingDecisionLogRelatedRefs:
      properties:
        orderRef:
          description: The orderRef of the order this decision log is related to.
          type: string
        processRef:
          description: The processRef of the process this decision log is related to.
          type: string
        routingPlanRefs:
          description: >-
            The routingPlanRefs of the routing plans this decision log is
            related to.
          items:
            type: string
          type: array
        runId:
          description: >-
            The runId of the connected sourcingOption this decision log is
            related to.
          type: string
        sourcingOptionRefs:
          description: >-
            The sourcingOptionsRefs of the request this decision log is related
            to.
          items:
            type: string
          type: array
        sourcingOptionsRef:
          deprecated: true
          description: >-
            The sourcingOptionsRef of the request this decision log is related
            to.
          type: string
        tenantOrderId:
          description: The tenantOrderId of the order this decision log is related to.
          type: string
      type: object
      xml:
        name: RoutingDecisionLogRelatedRefs
      title: RoutingDecisionLogRelatedRefs
      description: RoutingDecisionLogRelatedRefs
    RoutingDecisionLogs:
      properties:
        decisionLogs:
          items:
            $ref: '#/components/schemas/RoutingDecisionLog'
          type: array
        total:
          description: Total number of found decision logs for this query
          example: 42
          type: integer
      required:
        - decisionLogs
        - total
      type: object
      title: RoutingDecisionLogs
      description: RoutingDecisionLogs
    RoutingJournal:
      properties:
        blacklistedFacilityData:
          description: >-
            List of blacklisted facilities associated with this routing journal
            entry
          items:
            $ref: '#/components/schemas/RoutingJournalBlacklistedFacilityData'
          type: array
        changeType:
          description: Type of change recorded in this routing journal entry
          enum:
            - INITIAL
            - PROCESS_REROUTE
            - PROCESS_MANUAL_ASSIGNED
            - TASK_MANUAL_REROUTED
            - PICKJOB_REJECTED
          type: string
        created:
          description: Creation date of this routing journal entry
          format: date-time
          type: string
        id:
          description: Unique identifier of this routing journal entry
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        orderRef:
          description: Reference to the associated order
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        processRef:
          description: Reference to the associated process
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        routingPlanRefs:
          description: References to the routing plans associated with this journal entry
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
        runId:
          description: The technical id for a sourcing option evaluation
          type: string
        sourcingOptionRef:
          description: Reference to the sourcing option used for routing
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: object
      required:
        - runId
        - blacklistedFacilityData
        - id
        - created
        - processRef
        - orderRef
        - sourcingOptionRef
        - changeType
        - routingPlanRefs
      title: RoutingJournal
      type: object
      description: RoutingJournal
    RoutingJournalBlacklistedFacilityData:
      properties:
        facilityRef:
          description: Reference to the facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - facilityRef
      title: RoutingJournalBlacklistedFacilityData
      type: object
      description: RoutingJournalBlacklistedFacilityData
    RoutingJournals:
      properties:
        routingJournals:
          description: Array of the routing journal entries
          items:
            $ref: '#/components/schemas/RoutingJournal'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: number
      required:
        - routingJournals
        - total
      title: RoutingJournals
      type: object
      description: RoutingJournals
    RoutingPlan:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        activeConfig:
          $ref: '#/components/schemas/RoutingStrategyNodeConfig'
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        childRoutingPlanRef:
          type: string
        consolidatedStatus:
          $ref: '#/components/schemas/ConsolidatedRoutingPlanStatus'
        customServices:
          items:
            $ref: '#/components/schemas/CustomServiceReference'
          minItems: 1
          type: array
        decisionLogs:
          items:
            $ref: '#/components/schemas/DecisionLogRef'
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
        earliestPickingStart:
          $ref: '#/components/schemas/EarliestPickingStart'
        expectedLineItems:
          items:
            $ref: '#/components/schemas/ExpectedLineItem'
          type: array
        facilityBlackList:
          items:
            description: Contains a list of facilities to ignore when rerouting happens.
            type: string
          type: array
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        fallbackRoutingAfterTimeInSeconds:
          description: >-
            In case this routing plan has an active fallback facility
            configuration, this is the time in seconds after which the fallback
            routing will be attempted.
          type: number
        finalizeRun:
          description: The iteration through the finalizer process
          example: 5
          minimum: 0
          type: number
        firstRoutingAttempt:
          description: The date of the first routing attempt.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        history:
          items:
            $ref: '#/components/schemas/RoutingPlanHistory'
          type: array
        id:
          type: string
        latestPickingStart:
          $ref: '#/components/schemas/LatestPickingStart'
        orderDate:
          description: The date this order was created at the supplying system.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        orderLineItems:
          items:
            $ref: '#/components/schemas/RoutingPlanLineItem'
          type: array
        orderRef:
          description: >-
            The id of the order that lead to the creation of this pickjob. Can
            be empty / not present when the pickjob was created without having
            an order.
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        parentRoutingPlanRef:
          type: string
        pickJobRef:
          description: The id of the pickjob that has been created from the routing plan.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        predecessorRerouteRoutingPlanRefs:
          description: Refs of the predecessor routing plans, in the case of a reroute.
          items:
            type: string
          type: array
        priority:
          description: priority of return plan
          minimum: 0
          type: number
        processId:
          description: >-
            Id of the global process related to this entity. For example used
            for starting the GDPR process and others.
          type: string
        provisioningTime:
          description: The point in time by which the order is supposed to be provisioned.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        rerouteDescription:
          $ref: '#/components/schemas/RerouteDescription'
        reRoutedFacilityRef:
          description: The id of the facility the order was rerouted from.
          example: 1DEYZgmfAcXRVYv6KEka36
          type: string
        reRoutedPickJobRef:
          description: The id of the original pickjob that was rerouted.
          example: Eghhj20878dhbd989NdMp3C
          type: string
        reRoutedRoutingPlanRef:
          description: The id of the original routingplan that was rerouted.
          example: Eghhj20878dhbd989NdMp3C
          type: string
        reRouteReason:
          $ref: '#/components/schemas/RerouteReason'
        routingRun:
          description: The iteration through the routing process
          type: number
        runId:
          description: ID of the routing run this plan was created in
          type: string
        runType:
          description: The rule type of a decision log entry
          enum:
            - DEFAULT
            - REROUTE
            - ORDERSPLIT_ON_SHORTPICK
            - MANUAL_ASSIGNMENT
            - PROCESS_MANUALASSIGNMENT
            - REACTIVATION
          type: string
        splitCount:
          default: 0
          description: >-
            The number of order splits that happened before this routingplan was
            created
          example: 5
          minimum: 0
          type: number
        status:
          $ref: '#/components/schemas/RoutingPlanStatus'
        statusHistory:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated
             For more detailed information, use the History field. Saves all status changes when creating or updating a routing plan
          items:
            $ref: '#/components/schemas/RoutingPlanStatus'
          type: array
        statusReasons:
          items:
            $ref: '#/components/schemas/RoutingPlanStatusReason'
          type: array
        strandId:
          description: >-
            The id of the sourcing option strand this plan has been derived
            from.
          type: string
        successorRerouteRoutingPlanRefs:
          description: Refs of the succeeding routing plans, in the case of a reroute.
          items:
            type: string
          type: array
        targetAddress:
          $ref: '#/components/schemas/TargetAddress'
        targetAddressesByDeliveryEvent:
          items:
            $ref: '#/components/schemas/DeliveryEventTargetAddress'
          type: array
        targetTimeBaseDate:
          description: This date is used as base/start to calculate the target time date.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        tenantOrderId:
          description: >-
            The id of the order in the tenant system that lead to the creation
            of this routingplan.
          type: string
        transfers:
          items:
            $ref: '#/components/schemas/Transfer'
          type: array
        workflowInformation:
          oneOf:
            - $ref: '#/components/schemas/WorkflowInformation'
            - $ref: '#/components/schemas/WorkflowUnavailable'
      required:
        - id
        - orderDate
        - created
        - lastModified
        - version
        - orderRef
        - priority
        - status
        - consolidatedStatus
        - decisionLogs
        - routingRun
        - finalizeRun
        - processId
        - predecessorRerouteRoutingPlanRefs
        - successorRerouteRoutingPlanRefs
        - workflowInformation
      type: object
      title: RoutingPlan
      description: RoutingPlan
    RoutingPlanCustomServicesArticleItemsFilter:
      properties:
        tenantArticleRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: RoutingPlanCustomServicesArticleItemsFilter
      type: object
      description: RoutingPlanCustomServicesArticleItemsFilter
    RoutingPlanCustomServicesArticleItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanCustomServicesArticleItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanCustomServicesArticleItemsListFilter
      type: object
      description: RoutingPlanCustomServicesArticleItemsListFilter
    RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter:
      properties:
        additionalInformationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by additionalInformationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: >-
        RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter
      type: object
      description: >-
        RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter
    RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: >-
        RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter
      type: object
      description: >-
        RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter
    RoutingPlanCustomServicesCustomServiceDefinitionFilter:
      properties:
        additionalInformation:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionAdditionalInformationListFilter
          description: Nested list search by additionalInformation
        customServiceRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by customServiceRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: RoutingPlanCustomServicesCustomServiceDefinitionFilter
      type: object
      description: RoutingPlanCustomServicesCustomServiceDefinitionFilter
    RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter:
      properties:
        tenantArticleRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter
      type: object
      description: RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter
    RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter
      type: object
      description: RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter
    RoutingPlanCustomServicesCustomServiceItemsFilter:
      properties:
        articleItems:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceItemsArticleItemsListFilter
          description: Nested list search by articleItems
      title: RoutingPlanCustomServicesCustomServiceItemsFilter
      type: object
      description: RoutingPlanCustomServicesCustomServiceItemsFilter
    RoutingPlanCustomServicesCustomServiceItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceItemsFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanCustomServicesCustomServiceItemsListFilter
      type: object
      description: RoutingPlanCustomServicesCustomServiceItemsListFilter
    RoutingPlanCustomServicesFilter:
      properties:
        articleItems:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesArticleItemsListFilter
          description: Nested list search by articleItems
        customServiceDefinition:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceDefinitionFilter
          description: Nested search by customServiceDefinition
        customServiceItems:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanCustomServicesCustomServiceItemsListFilter
          description: Nested list search by customServiceItems
      title: RoutingPlanCustomServicesFilter
      type: object
      description: RoutingPlanCustomServicesFilter
    RoutingPlanCustomServicesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanCustomServicesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanCustomServicesListFilter
      type: object
      description: RoutingPlanCustomServicesListFilter
    RoutingPlanDeliveryPreferencesCollectFilter:
      properties:
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        paid:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by paid
        supplyingFacilities:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by supplyingFacilities
      title: RoutingPlanDeliveryPreferencesCollectFilter
      type: object
      description: RoutingPlanDeliveryPreferencesCollectFilter
    RoutingPlanDeliveryPreferencesCollectListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanDeliveryPreferencesCollectFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanDeliveryPreferencesCollectListFilter
      type: object
      description: RoutingPlanDeliveryPreferencesCollectListFilter
    RoutingPlanDeliveryPreferencesFilter:
      properties:
        collect:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanDeliveryPreferencesCollectListFilter
          description: Nested list search by collect
        shipping:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanDeliveryPreferencesShippingFilter
          description: Nested search by shipping
        supplyingFacilities:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by supplyingFacilities
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
      title: RoutingPlanDeliveryPreferencesFilter
      type: object
      description: RoutingPlanDeliveryPreferencesFilter
    RoutingPlanDeliveryPreferencesShippingFilter:
      properties:
        preferredCarriers:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by preferredCarriers
        preferredCarriersWithProduct:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter
          description: Nested list search by preferredCarriersWithProduct
      title: RoutingPlanDeliveryPreferencesShippingFilter
      type: object
      description: RoutingPlanDeliveryPreferencesShippingFilter
    RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter:
      properties:
        carrierKey:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierKey
      title: RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter
      type: object
      description: RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter
    RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: >-
        RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter
      type: object
      description: >-
        RoutingPlanDeliveryPreferencesShippingPreferredCarriersWithProductListFilter
    RoutingPlanEarliestPickingStartFilter:
      properties:
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        earliestPickingStartDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by earliestPickingStartDate
          example: 2026-06-17T12:00:00.000Z
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
      title: RoutingPlanEarliestPickingStartFilter
      type: object
      description: RoutingPlanEarliestPickingStartFilter
    RoutingPlanFallbackRoutingWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RoutingPlan'
      required:
        - payload
      type: object
      title: RoutingPlanFallbackRoutingWebHookEvent
      description: RoutingPlanFallbackRoutingWebHookEvent
    RoutingPlanHistory:
      properties:
        created:
          description: Information about the time, when a routing plan status is set
          example: 2024-05-12T08:45:50.525Z
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/RoutingPlanStatus'
      required:
        - status
        - created
      title: RoutingPlanHistory
      description: RoutingPlanHistory
    RoutingPlanHistoryFilter:
      properties:
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        status:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanHistoryRoutingPlanStatusEnumFilter
          description: Search by status
      title: RoutingPlanHistoryFilter
      type: object
      description: RoutingPlanHistoryFilter
    RoutingPlanHistoryListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanHistoryFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanHistoryListFilter
      type: object
      description: RoutingPlanHistoryListFilter
    RoutingPlanHistoryRoutingPlanStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - IN_PREPARATION
            - INITIAL
            - PRIORITIZED
            - ROUTING
            - PROPOSED
            - PLANNED
            - ROUTED
            - NOT_ROUTABLE
            - MANUAL_PLANNED
            - FAILED
            - REDUNDANT_REROUTE
            - FAILED_REROUTE
            - RETRYABLE
            - FALLBACK_ROUTING
            - WAITING
            - OBSOLETE
            - CANCELED
            - LOCKED
            - PROMISED
            - REROUTED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - IN_PREPARATION
              - INITIAL
              - PRIORITIZED
              - ROUTING
              - PROPOSED
              - PLANNED
              - ROUTED
              - NOT_ROUTABLE
              - MANUAL_PLANNED
              - FAILED
              - REDUNDANT_REROUTE
              - FAILED_REROUTE
              - RETRYABLE
              - FALLBACK_ROUTING
              - WAITING
              - OBSOLETE
              - CANCELED
              - LOCKED
              - PROMISED
              - REROUTED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - IN_PREPARATION
            - INITIAL
            - PRIORITIZED
            - ROUTING
            - PROPOSED
            - PLANNED
            - ROUTED
            - NOT_ROUTABLE
            - MANUAL_PLANNED
            - FAILED
            - REDUNDANT_REROUTE
            - FAILED_REROUTE
            - RETRYABLE
            - FALLBACK_ROUTING
            - WAITING
            - OBSOLETE
            - CANCELED
            - LOCKED
            - PROMISED
            - REROUTED
          type: string
      title: RoutingPlanHistoryRoutingPlanStatusEnumFilter
      type: object
      description: RoutingPlanHistoryRoutingPlanStatusEnumFilter
    RoutingPlanLatestPickingStartFilter:
      properties:
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        latestPickingStartDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by latestPickingStartDate
          example: 2026-06-17T12:00:00.000Z
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
      title: RoutingPlanLatestPickingStartFilter
      type: object
      description: RoutingPlanLatestPickingStartFilter
    RoutingPlanLineItem:
      allOf:
        - $ref: '#/components/schemas/OrderLineItem'
      properties:
        availabilityTimeframe:
          $ref: '#/components/schemas/AvailabilityTimeframe'
        available:
          type: number
        outOfStockBehaviour:
          $ref: '#/components/schemas/OutOfStockBehaviour'
        picked:
          type: number
        pieces:
          description: '@deprecated This property has been deprecated and has no meaning.'
          items:
            $ref: '#/components/schemas/RoutingPlanLineItemPiece'
          type: array
      title: RoutingPlanLineItem
      description: RoutingPlanLineItem
    RoutingPlanLineItemPiece:
      properties:
        available:
          type: number
        location:
          $ref: '#/components/schemas/Location'
        mandatoryScore:
          type: number
        partialStockRef:
          type: string
        picked:
          type: number
        quantity:
          type: number
        sequenceScore:
          type: number
      type: object
      title: RoutingPlanLineItemPiece
      description: RoutingPlanLineItemPiece
    RoutingPlanNotRoutableWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RoutingPlan'
      required:
        - payload
      type: object
      title: RoutingPlanNotRoutableWebHookEvent
      description: RoutingPlanNotRoutableWebHookEvent
    RoutingPlanOrderLineItemsFilter:
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: RoutingPlanOrderLineItemsFilter
      type: object
      description: RoutingPlanOrderLineItemsFilter
    RoutingPlanOrderLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanOrderLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanOrderLineItemsListFilter
      type: object
      description: RoutingPlanOrderLineItemsListFilter
    RoutingPlanPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        routingPlans:
          items:
            $ref: '#/components/schemas/RoutingPlan'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - routingPlans
      title: RoutingPlanPaginatedResult
      type: object
      description: RoutingPlanPaginatedResult
    RoutingPlanPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyRoutingPlanAction'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: RoutingPlanPatchActions
      title: RoutingPlanPatchActions
      description: RoutingPlanPatchActions
    RoutingPlanRerouteCreatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RoutingPlan'
      required:
        - payload
      type: object
      title: RoutingPlanRerouteCreatedWebHookEvent
      description: RoutingPlanRerouteCreatedWebHookEvent
    RoutingPlanRoutedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RoutingPlan'
      required:
        - payload
      type: object
      title: RoutingPlanRoutedWebHookEvent
      description: RoutingPlanRoutedWebHookEvent
    RoutingPlans:
      properties:
        routingPlans:
          items:
            $ref: '#/components/schemas/RoutingPlan'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: RoutingPlans
      description: RoutingPlans
    RoutingPlanSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/RoutingPlanSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/RoutingPlanSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: RoutingPlanSearchPayload
      type: object
      description: RoutingPlanSearchPayload
    RoutingPlanSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/RoutingPlanSearchQuery'
          maxItems: 500
          type: array
        anonymized:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by anonymized
        customServices:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanCustomServicesListFilter'
          description: Nested list search by customServices
        deliveryPreferences:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanDeliveryPreferencesFilter'
          description: Nested search by deliveryPreferences
        earliestPickingStart:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanEarliestPickingStartFilter'
          description: Nested search by earliestPickingStart
        history:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanHistoryListFilter'
          description: Nested list search by history
        latestPickingStart:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanLatestPickingStartFilter'
          description: Nested search by latestPickingStart
        or:
          items:
            $ref: '#/components/schemas/RoutingPlanSearchQuery'
          maxItems: 500
          type: array
        orderDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by orderDate. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
          example: 2026-06-17T12:00:00.000Z
        orderLineItems:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanOrderLineItemsListFilter'
          description: Nested list search by orderLineItems
        orderRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by orderRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        pickJobRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by pickJobRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        priority:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by priority
        processId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by processId
        provisioningTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by provisioningTime
          example: 2026-06-17T12:00:00.000Z
        reRouteReason:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by reRouteReason
        splitCount:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by splitCount
        status:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanStatusEnumFilter'
          description: Search by status
        statusReasons:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanStatusReasonsListFilter'
          description: Nested list search by statusReasons
        targetAddress:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanTargetAddressFilter'
          description: Nested search by targetAddress
      title: RoutingPlanSearchQuery
      type: object
      description: RoutingPlanSearchQuery
    RoutingPlansGraph:
      additionalProperties: false
      description: >-
        A graph representation of the routing plans. The nodes are the routing
        plans and the edges are the rerouting reasons.
      properties:
        edges:
          items:
            $ref: '#/components/schemas/RoutingPlansGraphEdge'
          type: array
        nodes:
          items:
            $ref: '#/components/schemas/RoutingPlansGraphNode'
          type: array
      required:
        - nodes
        - edges
      title: RoutingPlansGraph
    RoutingPlansGraphEdge:
      additionalProperties: false
      properties:
        from:
          type: string
        reason:
          $ref: '#/components/schemas/RoutingPlansGraphEdgeReason'
        to:
          type: string
      required:
        - from
        - to
        - reason
      type: object
      title: RoutingPlansGraphEdge
      description: RoutingPlansGraphEdge
    RoutingPlansGraphEdgeReason:
      enum:
        - SPLIT
        - REROUTE
        - INTER_FACILITY_TRANSFER
      type: string
      title: RoutingPlansGraphEdgeReason
      description: RoutingPlansGraphEdgeReason
    RoutingPlansGraphNode:
      additionalProperties: false
      properties:
        routingPlanRef:
          type: string
      required:
        - routingPlanRef
      type: object
      title: RoutingPlansGraphNode
      description: RoutingPlansGraphNode
    RoutingPlanSort:
      properties:
        anonymized:
          enum:
            - ASC
            - DESC
          type: string
        orderDate:
          enum:
            - ASC
            - DESC
          type: string
        orderRef:
          enum:
            - ASC
            - DESC
          type: string
        processId:
          enum:
            - ASC
            - DESC
          type: string
        provisioningTime:
          enum:
            - ASC
            - DESC
          type: string
        status:
          enum:
            - ASC
            - DESC
          type: string
      title: RoutingPlanSort
      type: object
      description: RoutingPlanSort
    RoutingPlanSplittedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RoutingPlan'
      required:
        - payload
      type: object
      title: RoutingPlanSplittedWebHookEvent
      description: RoutingPlanSplittedWebHookEvent
    RoutingPlanStatus:
      description: >-
        A routing plan line initially has the status INITIAL. Final state is
        ROUTED
      enum:
        - IN_PREPARATION
        - INITIAL
        - PRIORITIZED
        - ROUTING
        - PROPOSED
        - PLANNED
        - ROUTED
        - NOT_ROUTABLE
        - MANUAL_PLANNED
        - FAILED
        - REDUNDANT_REROUTE
        - FAILED_REROUTE
        - RETRYABLE
        - FALLBACK_ROUTING
        - WAITING
        - OBSOLETE
        - CANCELED
        - LOCKED
        - PROMISED
        - REROUTED
      type: string
      xml:
        name: RoutingPlanStatus
      title: RoutingPlanStatus
    RoutingPlanStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - IN_PREPARATION
            - INITIAL
            - PRIORITIZED
            - ROUTING
            - PROPOSED
            - PLANNED
            - ROUTED
            - NOT_ROUTABLE
            - MANUAL_PLANNED
            - FAILED
            - REDUNDANT_REROUTE
            - FAILED_REROUTE
            - RETRYABLE
            - FALLBACK_ROUTING
            - WAITING
            - OBSOLETE
            - CANCELED
            - LOCKED
            - PROMISED
            - REROUTED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - IN_PREPARATION
              - INITIAL
              - PRIORITIZED
              - ROUTING
              - PROPOSED
              - PLANNED
              - ROUTED
              - NOT_ROUTABLE
              - MANUAL_PLANNED
              - FAILED
              - REDUNDANT_REROUTE
              - FAILED_REROUTE
              - RETRYABLE
              - FALLBACK_ROUTING
              - WAITING
              - OBSOLETE
              - CANCELED
              - LOCKED
              - PROMISED
              - REROUTED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - IN_PREPARATION
            - INITIAL
            - PRIORITIZED
            - ROUTING
            - PROPOSED
            - PLANNED
            - ROUTED
            - NOT_ROUTABLE
            - MANUAL_PLANNED
            - FAILED
            - REDUNDANT_REROUTE
            - FAILED_REROUTE
            - RETRYABLE
            - FALLBACK_ROUTING
            - WAITING
            - OBSOLETE
            - CANCELED
            - LOCKED
            - PROMISED
            - REROUTED
          type: string
      title: RoutingPlanStatusEnumFilter
      type: object
      description: RoutingPlanStatusEnumFilter
    RoutingPlanStatusReason:
      description: Obsolete Status Reason
      properties:
        reason:
          $ref: '#/components/schemas/RoutingPlanStatusReasonReason'
        status:
          $ref: '#/components/schemas/RoutingPlanStatusReasonStatus'
      required:
        - reason
        - status
      title: RoutingPlanStatusReason
    RoutingPlanStatusReasonReason:
      enum:
        - REROUTE_AFTER_SHORTPICK
        - MANUALLY_REROUTED
        - MANUALLY_ASSIGNED
        - ORDER_MODIFIED
      type: string
      title: RoutingPlanStatusReasonReason
      description: RoutingPlanStatusReasonReason
    RoutingPlanStatusReasonsFilter:
      properties:
        reason:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter
          description: Search by reason
        status:
          allOf:
            - $ref: >-
                #/components/schemas/RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter
          description: Search by status
      title: RoutingPlanStatusReasonsFilter
      type: object
      description: RoutingPlanStatusReasonsFilter
    RoutingPlanStatusReasonsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/RoutingPlanStatusReasonsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: RoutingPlanStatusReasonsListFilter
      type: object
      description: RoutingPlanStatusReasonsListFilter
    RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter:
      properties:
        eq:
          description: Search by reason
          enum:
            - REROUTE_AFTER_SHORTPICK
            - MANUALLY_REROUTED
            - MANUALLY_ASSIGNED
            - ORDER_MODIFIED
          type: string
        in:
          description: Search by reason
          items:
            enum:
              - REROUTE_AFTER_SHORTPICK
              - MANUALLY_REROUTED
              - MANUALLY_ASSIGNED
              - ORDER_MODIFIED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by reason
          enum:
            - REROUTE_AFTER_SHORTPICK
            - MANUALLY_REROUTED
            - MANUALLY_ASSIGNED
            - ORDER_MODIFIED
          type: string
      title: RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter
      type: object
      description: RoutingPlanStatusReasonsRoutingPlanStatusReasonReasonEnumFilter
    RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OBSOLETE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OBSOLETE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OBSOLETE
          type: string
      title: RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter
      type: object
      description: RoutingPlanStatusReasonsRoutingPlanStatusReasonStatusEnumFilter
    RoutingPlanStatusReasonStatus:
      enum:
        - OBSOLETE
      type: string
      title: RoutingPlanStatusReasonStatus
      description: RoutingPlanStatusReasonStatus
    RoutingPlanTargetAddressFilter:
      properties:
        city:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by city
          example: Yellowstone
        country:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by country
          example: US
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        province:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by province
        street:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by street
      title: RoutingPlanTargetAddressFilter
      type: object
      description: RoutingPlanTargetAddressFilter
    RoutingPlanWaitingWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/RoutingPlan'
      required:
        - payload
      type: object
      title: RoutingPlanWaitingWebHookEvent
      description: RoutingPlanWaitingWebHookEvent
    RoutingResults:
      properties:
        assignedItems:
          items:
            $ref: '#/components/schemas/AssignmentItem'
          type: array
        bestAvailableFacility:
          $ref: '#/components/schemas/DecisionLogFacilityInfo'
        bestRatedFacility:
          $ref: '#/components/schemas/DecisionLogFacilityInfo'
        bestReassignmentFacility:
          $ref: '#/components/schemas/DecisionLogFacilityInfo'
        routingPlanStatus:
          $ref: '#/components/schemas/RoutingPlanStatus'
      required:
        - assignedItems
      title: RoutingResults
      description: RoutingResults
    RoutingRule:
      additionalProperties: false
      properties:
        fences:
          items:
            $ref: '#/components/schemas/Fence'
          type: array
        orderSplit:
          $ref: '#/components/schemas/OrderSplit'
        ratings:
          items:
            $ref: '#/components/schemas/Rating'
          type: array
      required:
        - ratings
        - fences
      type: object
      title: RoutingRule
      description: RoutingRule
    RoutingStatistics:
      properties:
        durationMs:
          type: number
        fenceStatistics:
          items:
            $ref: '#/components/schemas/FenceStatistic'
          type: array
        ratingStatistics:
          items:
            $ref: '#/components/schemas/RatingStatistic'
          type: array
      required:
        - fenceStatistics
        - ratingStatistics
        - lineItemFenceStatistics
      title: RoutingStatistics
      description: RoutingStatistics
    RoutingStrategy:
      additionalProperties: true
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            nameLocalized:
              $ref: '#/components/schemas/LocaleString'
            globalConfiguration:
              $ref: '#/components/schemas/RoutingStrategyGlobalConfiguration'
            id:
              type: string
            inUse:
              description: Only one strategy can be inUse
              type: boolean
            name:
              type: string
            revision:
              description: The revision of the routing strategy
              example: 1
              type: integer
            rootNode:
              $ref: '#/components/schemas/RoutingStrategyNode'
          required:
            - inUse
            - revision
            - id
            - nameLocalized
            - rootNode
            - globalConfiguration
      type: object
      title: RoutingStrategy
      description: RoutingStrategy
    RoutingStrategyActionsParameter:
      oneOf:
        - $ref: '#/components/schemas/RoutingStrategyActivateActionParameter'
        - $ref: '#/components/schemas/RoutingStrategyCreateCopyActionParameter'
        - $ref: >-
            #/components/schemas/RoutingStrategyReplaceGlobalConfigurationActionParameter
        - $ref: '#/components/schemas/RoutingStrategyReplaceNodeActionParameter'
        - $ref: '#/components/schemas/RoutingStrategyReplaceConditionActionParameter'
      title: RoutingStrategyActionsParameter
      description: RoutingStrategyActionsParameter
    RoutingStrategyActivateActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractRoutingStrategyActionsParameter'
      description: Action to activate a routing strategy.
      properties:
        name:
          enum:
            - ACTIVATE
          type: string
      required:
        - name
        - version
      title: RoutingStrategyActivateActionParameter
    RoutingStrategyCondition:
      additionalProperties: false
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        description:
          type: string
        id:
          type: string
        name:
          type: string
        nextCondition:
          $ref: '#/components/schemas/RoutingStrategyCondition'
        nextNode:
          $ref: '#/components/schemas/RoutingStrategyNode'
        rule:
          $ref: '#/components/schemas/RoutingStrategyConditionRule'
      required:
        - nextNode
        - active
        - rule
        - id
        - nameLocalized
      title: RoutingStrategyCondition
      description: RoutingStrategyCondition
    RoutingStrategyConditionForCreation:
      additionalProperties: false
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        description:
          type: string
        name:
          type: string
        nextCondition:
          $ref: '#/components/schemas/RoutingStrategyConditionForCreation'
        nextNode:
          $ref: '#/components/schemas/RoutingStrategyNodeForCreation'
        rule:
          $ref: '#/components/schemas/RoutingStrategyConditionRule'
      required:
        - nextNode
        - active
        - rule
        - nameLocalized
      title: RoutingStrategyConditionForCreation
      description: RoutingStrategyConditionForCreation
    RoutingStrategyConditionForModification:
      additionalProperties: false
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        description:
          type: string
        name:
          type: string
        nextCondition:
          $ref: '#/components/schemas/RoutingStrategyConditionForModification'
        nextNode:
          $ref: '#/components/schemas/RoutingStrategyNodeForModification'
        rule:
          $ref: '#/components/schemas/RoutingStrategyConditionRule'
      required:
        - nextNode
        - active
        - rule
        - nameLocalized
      title: RoutingStrategyConditionForModification
      description: RoutingStrategyConditionForModification
    RoutingStrategyConditionForReplace:
      additionalProperties: false
      description: Condition data for replacing a condition in a routing strategy.
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        rule:
          $ref: '#/components/schemas/RoutingStrategyConditionRule'
      required:
        - active
        - nameLocalized
        - rule
      title: RoutingStrategyConditionForReplace
    RoutingStrategyConditionPredicate:
      description: The predicate for a routing strategy condition rule
      properties:
        entityOperator:
          $ref: '#/components/schemas/ToolkitEntityOperatorType'
        expectedValue:
          oneOf:
            - type: string
            - type: number
            - type: boolean
        propertyPath:
          minLength: 1
          type: string
        transformation:
          $ref: '#/components/schemas/ToolkitTransformationType'
        transformationArgs:
          items:
            oneOf:
              - type: string
              - type: number
              - type: boolean
          maxItems: 100
          type: array
      required:
        - propertyPath
        - entityOperator
      type: object
      xml:
        name: RoutingStrategyConditionPredicate
      title: RoutingStrategyConditionPredicate
    RoutingStrategyConditionRule:
      additionalProperties: false
      properties:
        predicateConnector:
          $ref: '#/components/schemas/ToolkitPredicateConnector'
        predicates:
          items:
            $ref: '#/components/schemas/RoutingStrategyConditionPredicate'
          maxItems: 100
          minItems: 1
          type: array
      required:
        - predicates
      type: object
      xml:
        name: RoutingStrategyConditionRule
      title: RoutingStrategyConditionRule
      description: RoutingStrategyConditionRule
    RoutingStrategyCreateCopyActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractRoutingStrategyActionsParameter'
      description: Action to create a copy of a routing strategy.
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        name:
          enum:
            - COPY
          type: string
      required:
        - name
        - nameLocalized
        - version
      title: RoutingStrategyCreateCopyActionParameter
    RoutingStrategyEvaluationResult:
      properties:
        evaluatedConfig:
          $ref: '#/components/schemas/RoutingStrategyNodeConfig'
        evaluatedPath:
          items:
            $ref: '#/components/schemas/RoutingStrategyPathElement'
          type: array
      required:
        - evaluatedConfig
        - evaluatedPath
      type: object
      title: RoutingStrategyEvaluationResult
      description: RoutingStrategyEvaluationResult
    RoutingStrategyEvaluationResultType:
      enum:
        - NODE_INACTIVE
        - NODE_ACTIVE
        - CONDITION_INACTIVE
        - CONDITION_FALSE
        - CONDITION_TRUE
      type: string
      title: RoutingStrategyEvaluationResultType
      description: RoutingStrategyEvaluationResultType
    RoutingStrategyFacilityRerouteConfig:
      additionalProperties: false
      properties:
        active:
          type: boolean
        rerouteType:
          $ref: '#/components/schemas/RoutingStrategyRerouteType'
      required:
        - rerouteType
      type: object
      title: RoutingStrategyFacilityRerouteConfig
      description: RoutingStrategyFacilityRerouteConfig
    RoutingStrategyFallbackFacilityConfig:
      properties:
        active:
          default: false
          type: boolean
        facilityRefs:
          items:
            type: string
          maxItems: 1
          minItems: 1
          type: array
        fallbackAfterTime:
          default: PT0H
          description: >-
            Default amount of time in ISO 8601 duration format after which a not
            routable routingplan is routed to a configured fallback facility.
          pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
      required:
        - facilityRefs
        - active
        - fallbackAfterTime
      title: RoutingStrategyFallbackFacilityConfig
      description: RoutingStrategyFallbackFacilityConfig
    RoutingStrategyForCreation:
      additionalProperties: false
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
      required:
        - nameLocalized
      type: object
      xml:
        name: RoutingStrategy
      title: RoutingStrategyForCreation
      description: RoutingStrategyForCreation
    RoutingStrategyForModification:
      additionalProperties: false
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        globalConfiguration:
          $ref: '#/components/schemas/RoutingStrategyGlobalConfiguration'
        rootNode:
          $ref: '#/components/schemas/RoutingStrategyNodeForModification'
        version:
          type: integer
      required:
        - rootNode
        - nameLocalized
        - version
      xml:
        name: RoutingStrategyForModification
      title: RoutingStrategyForModification
      description: RoutingStrategyForModification
    RoutingStrategyGlobalConfiguration:
      additionalProperties: false
      properties:
        blacklistAssignedFacilities:
          description: >-
            If true, facilities that have already been assigned to the order in
            a previous routing attempt will not be considered in the next
            routing attempt.
          type: boolean
        defaultPrice:
          default: 10
          description: >-
            The price applied when no specific price is defined in the order or
            listing
          type: number
        restowAfterMinutes:
          description: >-
            The amount of minutes after which a restow is executed. If not set,
            restows will not be executed.
          type: number
        stopRoutingAttemptsAfterTime:
          default: PT8H
          description: >-
            The amount of time, specified in ISO 8601 duration format, after
            which a routing plan is considered not routable. Note: The duration
            must be a multiple of 60 seconds.
          pattern: ^P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          type: string
        timeTriggered:
          $ref: '#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig'
        timeTriggeredByContext:
          items:
            $ref: '#/components/schemas/TimeTriggeredConfigurationContext'
          maxItems: 500
          type: array
      required:
        - defaultPrice
      type: object
      xml:
        name: RoutingStrategyGlobalConfiguration
      title: RoutingStrategyGlobalConfiguration
      description: RoutingStrategyGlobalConfiguration
    RoutingStrategyNode:
      additionalProperties: false
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        categoryRef:
          type: string
        config:
          $ref: '#/components/schemas/RoutingStrategyNodeConfig'
        description:
          type: string
        id:
          type: string
        name:
          type: string
        nextCondition:
          $ref: '#/components/schemas/RoutingStrategyCondition'
      required:
        - active
        - config
        - id
        - nameLocalized
      type: object
      title: RoutingStrategyNode
      description: RoutingStrategyNode
    RoutingStrategyNodeConfig:
      additionalProperties: false
      properties:
        fallbackFacility:
          $ref: '#/components/schemas/RoutingStrategyFallbackFacilityConfig'
        fences:
          items:
            anyOf:
              - $ref: '#/components/schemas/RoutingStrategyStandardFence'
              - $ref: '#/components/schemas/RoutingStrategyToolkitFence'
            discriminator:
              propertyName: type
              mapping:
                StandardFence: '#/components/schemas/RoutingStrategyStandardFence'
                ToolkitFence: '#/components/schemas/RoutingStrategyToolkitFence'
          type: array
        orderSplit:
          $ref: '#/components/schemas/RoutingStrategyOrderSplitConfig'
        priorityRatings:
          items:
            anyOf:
              - $ref: '#/components/schemas/RoutingStrategyStandardPriorityRating'
              - $ref: '#/components/schemas/RoutingStrategyToolkitPriorityRating'
            discriminator:
              propertyName: type
              mapping:
                StandardPriorityRating: '#/components/schemas/RoutingStrategyStandardPriorityRating'
                ToolkitPriorityRating: '#/components/schemas/RoutingStrategyToolkitPriorityRating'
          type: array
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          x-badges:
            - color: red
              label: ALPHA
        ratings:
          items:
            anyOf:
              - $ref: '#/components/schemas/RoutingStrategyStandardRating'
              - $ref: '#/components/schemas/RoutingStrategyToolkitRating'
            discriminator:
              propertyName: type
              mapping:
                StandardRating: '#/components/schemas/RoutingStrategyStandardRating'
                ToolkitRating: '#/components/schemas/RoutingStrategyToolkitRating'
          type: array
        reroute:
          $ref: '#/components/schemas/RoutingStrategyRerouteConfig'
      required:
        - fences
        - ratings
      type: object
      title: RoutingStrategyNodeConfig
      description: RoutingStrategyNodeConfig
    RoutingStrategyNodeConfigCategory:
      allOf:
        - $ref: '#/components/schemas/RoutingStrategyNodeConfigCategoryForCreation'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
      required:
        - id
      title: RoutingStrategyNodeConfigCategory
      description: RoutingStrategyNodeConfigCategory
    RoutingStrategyNodeConfigCategoryForCreation:
      additionalProperties: false
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        color:
          type: string
      required:
        - nameLocalized
        - color
      type: object
      title: RoutingStrategyNodeConfigCategoryForCreation
      description: RoutingStrategyNodeConfigCategoryForCreation
    RoutingStrategyNodeConfigCategoryForModification:
      additionalProperties: false
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        color:
          type: string
        version:
          type: number
      required:
        - nameLocalized
        - color
        - version
      type: object
      title: RoutingStrategyNodeConfigCategoryForModification
      description: RoutingStrategyNodeConfigCategoryForModification
    RoutingStrategyNodeConfigCategoryForResponse:
      allOf:
        - $ref: '#/components/schemas/RoutingStrategyNodeConfigCategory'
      properties:
        name:
          type: string
      title: RoutingStrategyNodeConfigCategoryForResponse
      description: RoutingStrategyNodeConfigCategoryForResponse
    RoutingStrategyNodeConfigCategoryTransporter:
      properties:
        routingStrategyNodeConfigCategories:
          items:
            $ref: '#/components/schemas/RoutingStrategyNodeConfigCategoryForResponse'
          type: array
        total:
          description: Total number of entities found for this query
          example: 42
          type: integer
      required:
        - routingStrategyNodeConfigCategories
        - total
      type: object
      xml:
        name: RoutingStrategyNodeConfigCategoryTransporter
      title: RoutingStrategyNodeConfigCategoryTransporter
      description: RoutingStrategyNodeConfigCategoryTransporter
    RoutingStrategyNodeConfigForUpsert:
      additionalProperties: false
      properties:
        fallbackFacility:
          $ref: '#/components/schemas/RoutingStrategyFallbackFacilityConfig'
        fences:
          items:
            anyOf:
              - $ref: '#/components/schemas/RoutingStrategyStandardFenceForUpsert'
              - $ref: '#/components/schemas/RoutingStrategyToolkitFence'
            discriminator:
              propertyName: type
              mapping:
                StandardFence: '#/components/schemas/RoutingStrategyStandardFenceForUpsert'
                ToolkitFence: '#/components/schemas/RoutingStrategyToolkitFence'
          maxItems: 100
          type: array
        orderSplit:
          $ref: '#/components/schemas/RoutingStrategyOrderSplitConfig'
        priorityRatings:
          items:
            anyOf:
              - $ref: '#/components/schemas/RoutingStrategyPriorityRatingForUpsert'
              - $ref: '#/components/schemas/RoutingStrategyToolkitPriorityRating'
            discriminator:
              propertyName: type
              mapping:
                StandardPriorityRating: '#/components/schemas/RoutingStrategyPriorityRatingForUpsert'
                ToolkitPriorityRating: '#/components/schemas/RoutingStrategyToolkitPriorityRating'
          maxItems: 100
          type: array
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br />
          x-badges:
            - color: red
              label: ALPHA
        ratings:
          items:
            anyOf:
              - $ref: '#/components/schemas/RoutingStrategyRatingForUpsert'
              - $ref: '#/components/schemas/RoutingStrategyToolkitRating'
            discriminator:
              propertyName: type
              mapping:
                StandardRating: '#/components/schemas/RoutingStrategyRatingForUpsert'
                ToolkitRating: '#/components/schemas/RoutingStrategyToolkitRating'
          maxItems: 100
          type: array
        reroute:
          $ref: '#/components/schemas/RoutingStrategyRerouteConfig'
      required:
        - fences
        - ratings
      type: object
      title: RoutingStrategyNodeConfigForUpsert
      description: RoutingStrategyNodeConfigForUpsert
    RoutingStrategyNodeForCreation:
      additionalProperties: false
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        categoryRef:
          type: string
        config:
          $ref: '#/components/schemas/RoutingStrategyNodeConfigForUpsert'
        description:
          type: string
        name:
          type: string
        nextCondition:
          $ref: '#/components/schemas/RoutingStrategyConditionForCreation'
      required:
        - active
        - config
        - nameLocalized
      type: object
      title: RoutingStrategyNodeForCreation
      description: RoutingStrategyNodeForCreation
    RoutingStrategyNodeForModification:
      additionalProperties: false
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        categoryRef:
          type: string
        config:
          $ref: '#/components/schemas/RoutingStrategyNodeConfigForUpsert'
        description:
          type: string
        name:
          type: string
        nextCondition:
          $ref: '#/components/schemas/RoutingStrategyConditionForModification'
      required:
        - active
        - config
        - nameLocalized
      type: object
      title: RoutingStrategyNodeForModification
      description: RoutingStrategyNodeForModification
    RoutingStrategyNodeForReplace:
      additionalProperties: false
      description: Node data for replacing a node in a routing strategy.
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        activationTimeFrames:
          items:
            $ref: '#/components/schemas/ActivationTimeFrame'
          maxItems: 1
          type: array
        active:
          type: boolean
        categoryRef:
          type: string
        config:
          $ref: '#/components/schemas/RoutingStrategyNodeConfigForUpsert'
      required:
        - active
        - nameLocalized
        - config
      title: RoutingStrategyNodeForReplace
    RoutingStrategyOrderSplitConfig:
      additionalProperties: false
      properties:
        active:
          type: boolean
        activeForSameday:
          type: boolean
        maxSplitCount:
          type: integer
        shouldUseWaitingRoomForPreBackOrderItems:
          type: boolean
      required:
        - active
        - maxSplitCount
        - activeForSameday
        - shouldUseWaitingRoomForPreBackOrderItems
      type: object
      title: RoutingStrategyOrderSplitConfig
      description: RoutingStrategyOrderSplitConfig
    RoutingStrategyPathElement:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        evaluationResult:
          $ref: '#/components/schemas/RoutingStrategyEvaluationResultType'
        ref:
          type: string
        type:
          $ref: '#/components/schemas/RoutingStrategyPathElementType'
      required:
        - type
        - ref
        - evaluationResult
        - nameLocalized
      type: object
      title: RoutingStrategyPathElement
      description: RoutingStrategyPathElement
    RoutingStrategyPathElementType:
      enum:
        - CONDITION
        - NODE
      type: string
      title: RoutingStrategyPathElementType
      description: RoutingStrategyPathElementType
    RoutingStrategyPriorityRatingForUpsert:
      additionalProperties: false
      description: >-
        A rating is used to rate a set of possible facilities against each other
        during routing of orders, ordered by priority.
      properties:
        active:
          type: boolean
        configuration:
          $ref: '#/components/schemas/AbstractRatingConfiguration'
        implementation:
          $ref: '#/components/schemas/RatingImplementation'
        priority:
          example: 100
          minimum: 0
          type: number
        type:
          $ref: '#/components/schemas/RoutingStrategyStandardPriorityRatingType'
      required:
        - type
        - active
        - implementation
        - priority
      title: RoutingStrategyPriorityRatingForUpsert
      type: object
    RoutingStrategyRatingForUpsert:
      additionalProperties: false
      description: >-
        A rating is used to rate a set of possible facilities against each other
        during routing of orders.
      properties:
        active:
          type: boolean
        configuration:
          $ref: '#/components/schemas/AbstractRatingConfiguration'
        implementation:
          $ref: '#/components/schemas/RatingImplementation'
        maxPenalty:
          example: 100
          minimum: 0
          type: number
        type:
          $ref: '#/components/schemas/RoutingStrategyStandardRatingType'
      required:
        - type
        - active
        - implementation
        - maxPenalty
      title: RoutingStrategyRatingForUpsert
      type: object
    RoutingStrategyReplaceConditionActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractRoutingStrategyActionsParameter'
      description: Action to replace a condition of a routing strategy.
      properties:
        condition:
          $ref: '#/components/schemas/RoutingStrategyConditionForReplace'
        conditionId:
          type: string
        name:
          enum:
            - REPLACE_CONDITION
          type: string
      required:
        - name
        - conditionId
        - condition
        - version
      title: RoutingStrategyReplaceConditionActionParameter
    RoutingStrategyReplaceGlobalConfigurationActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractRoutingStrategyActionsParameter'
      description: Action to replace the global configuration of a routing strategy.
      properties:
        globalConfiguration:
          $ref: '#/components/schemas/RoutingStrategyGlobalConfiguration'
        name:
          enum:
            - REPLACE_GLOBAL_CONFIGURATION
          type: string
      required:
        - name
        - globalConfiguration
        - version
      title: RoutingStrategyReplaceGlobalConfigurationActionParameter
    RoutingStrategyReplaceNodeActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractRoutingStrategyActionsParameter'
      description: Action to replace a node of a routing strategy.
      properties:
        name:
          enum:
            - REPLACE_NODE
          type: string
        node:
          $ref: '#/components/schemas/RoutingStrategyNodeForReplace'
        nodeId:
          type: string
      required:
        - name
        - nodeId
        - node
        - version
      title: RoutingStrategyReplaceNodeActionParameter
    RoutingStrategyRerouteConfig:
      additionalProperties: false
      properties:
        clickAndCollect:
          $ref: '#/components/schemas/RoutingStrategyFacilityRerouteConfig'
        manualReroute:
          type: boolean
        rerouteZeroPicksOnly:
          default: false
          description: >-
            Specifies whether only pick jobs with zero items picked are eligible
            for rerouting.
          type: boolean
        shipFromStore:
          $ref: '#/components/schemas/RoutingStrategyFacilityRerouteConfig'
      type: object
      title: RoutingStrategyRerouteConfig
      description: RoutingStrategyRerouteConfig
    RoutingStrategyRerouteTimeTriggeredConfig:
      additionalProperties: false
      properties:
        clickAndCollectReroute:
          $ref: '#/components/schemas/RerouteConfiguration'
        shipFromStoreDeliveryReroute:
          $ref: '#/components/schemas/RerouteConfiguration'
        shipFromStoreSamedayReroute:
          $ref: '#/components/schemas/RerouteConfiguration'
      required:
        - clickAndCollectReroute
        - shipFromStoreDeliveryReroute
        - shipFromStoreSamedayReroute
      type: object
      title: RoutingStrategyRerouteTimeTriggeredConfig
      description: RoutingStrategyRerouteTimeTriggeredConfig
    RoutingStrategyRerouteType:
      description: |-
        The type of reroute to apply to the order
          * `REROUTE`- the complete routing plan is rerouted.
          * `ORDERSPLIT`- the order is splitted. The split line items will be moved to a new routing plan and rerouted.
      enum:
        - REROUTE
        - ORDERSPLIT
      type: string
      title: RoutingStrategyRerouteType
    RoutingStrategyStandardFence:
      additionalProperties: false
      description: Routing Strategy Fence.
      properties:
        active:
          type: boolean
        activeMode:
          $ref: '#/components/schemas/FenceMode'
        description:
          type: string
        implementation:
          $ref: '#/components/schemas/FenceImplementation'
        name:
          type: string
        supportedModes:
          items:
            $ref: '#/components/schemas/FenceMode'
          type: array
        type:
          $ref: '#/components/schemas/RoutingStrategyStandardFenceType'
      required:
        - active
        - implementation
        - type
      title: RoutingStrategyFence
      type: object
    RoutingStrategyStandardFenceForUpsert:
      additionalProperties: false
      description: Routing Strategy Fence.
      properties:
        active:
          type: boolean
        activeMode:
          $ref: '#/components/schemas/FenceMode'
        implementation:
          $ref: '#/components/schemas/FenceImplementation'
        type:
          $ref: '#/components/schemas/RoutingStrategyStandardFenceType'
      required:
        - active
        - implementation
        - type
      title: RoutingStrategyFence
      type: object
    RoutingStrategyStandardFenceType:
      enum:
        - StandardFence
      type: string
      title: RoutingStrategyStandardFenceType
      description: RoutingStrategyStandardFenceType
    RoutingStrategyStandardPriorityRating:
      additionalProperties: false
      description: >-
        A rating is used to rate a set of possible facilities against each other
        during routing of orders, ordered by priority.
      properties:
        active:
          type: boolean
        configuration:
          $ref: '#/components/schemas/AbstractRatingConfiguration'
        description:
          type: string
        implementation:
          $ref: '#/components/schemas/RatingImplementation'
        name:
          type: string
        priority:
          example: 100
          minimum: 0
          type: number
        type:
          $ref: '#/components/schemas/RoutingStrategyStandardPriorityRatingType'
      required:
        - active
        - priority
        - type
        - implementation
      title: RoutingStrategyStandardPriorityRating
      type: object
    RoutingStrategyStandardPriorityRatingType:
      description: >-
        Discriminator identifying a rating as a routing strategy standard
        rating, ordered by priority.
      enum:
        - StandardPriorityRating
      type: string
      title: RoutingStrategyStandardPriorityRatingType
    RoutingStrategyStandardRating:
      additionalProperties: false
      description: >-
        A rating is used to rate a set of possible facilities against each other
        during routing of orders.
      properties:
        active:
          type: boolean
        configuration:
          $ref: '#/components/schemas/AbstractRatingConfiguration'
        description:
          type: string
        implementation:
          $ref: '#/components/schemas/RatingImplementation'
        maxPenalty:
          example: 100
          minimum: 0
          type: number
        name:
          type: string
        type:
          $ref: '#/components/schemas/RoutingStrategyStandardRatingType'
      required:
        - active
        - maxPenalty
        - type
        - implementation
      title: RoutingStrategyStandardRating
      type: object
    RoutingStrategyStandardRatingType:
      description: >-
        Discriminator identifying a rating as a routing strategy standard
        rating.
      enum:
        - StandardRating
      type: string
      title: RoutingStrategyStandardRatingType
    RoutingStrategyToolkitFence:
      additionalProperties: false
      description: Routing Strategy Toolkit Fence.
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          default: false
          description: Indicates whether this fence is active or not.
          type: boolean
        comparisonRule:
          $ref: '#/components/schemas/ToolkitComparisonRule'
        description:
          description: The description of this fence.
          example: Some text that describes what the fence does.
          type: string
        entity1:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        entity2:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        name:
          description: The name of the fence.
          example: CustomFence
          type: string
        order:
          description: Order in which this fence is executed
          example: 1
          type: integer
        referenceId:
          type: string
        rule:
          $ref: '#/components/schemas/ToolkitRule'
        type:
          $ref: '#/components/schemas/RoutingStrategyToolkitFenceType'
      required:
        - nameLocalized
        - active
        - order
        - type
        - referenceId
      title: RoutingStrategyToolkitFence
    RoutingStrategyToolkitFenceType:
      enum:
        - ToolkitFence
      type: string
      title: RoutingStrategyToolkitFenceType
      description: RoutingStrategyToolkitFenceType
    RoutingStrategyToolkitPriorityRating:
      additionalProperties: false
      description: Routing Strategy Toolkit Rating, ordered by priority.
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          type: boolean
        comparisonRule:
          $ref: '#/components/schemas/ToolkitComparisonRule'
        description:
          description: The description of this rating
          example: Some text that describes what the rating does.
          type: string
        entity1:
          allOf:
            - $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        entity2:
          allOf:
            - $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        name:
          description: The name of the rating
          example: CustomRating
          type: string
        priority:
          description: The priority of this rating
          example: 100
          type: integer
        referenceId:
          type: string
        rule:
          $ref: '#/components/schemas/ToolkitRule'
        type:
          $ref: '#/components/schemas/RoutingStrategyToolkitPriorityRatingType'
      required:
        - active
        - priority
        - referenceId
        - nameLocalized
        - type
      title: RoutingStrategyToolkitPriorityRating
      type: object
    RoutingStrategyToolkitPriorityRatingType:
      description: >-
        Discriminator identifying a rating as a routing strategy toolkit rating,
        ordered by priority.
      enum:
        - ToolkitPriorityRating
      type: string
      title: RoutingStrategyToolkitPriorityRatingType
    RoutingStrategyToolkitRating:
      additionalProperties: false
      description: Routing Strategy Toolkit Rating.
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          default: false
          description: Indicates whether this rating is active or not
          type: boolean
        comparisonRule:
          $ref: '#/components/schemas/ToolkitComparisonRule'
        description:
          description: The description of this rating
          example: Some text that describes what the rating does.
          type: string
        entity1:
          allOf:
            - $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        entity2:
          allOf:
            - $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        maxPenalty:
          description: The maximum penalty this rating can have
          example: 100
          type: integer
        name:
          description: The name of the rating
          example: CustomRating
          type: string
        referenceId:
          type: string
        rule:
          $ref: '#/components/schemas/ToolkitRule'
        type:
          $ref: '#/components/schemas/RoutingStrategyToolkitRatingType'
      required:
        - active
        - maxPenalty
        - referenceId
        - nameLocalized
        - type
      title: RoutingStrategyToolkitRating
      type: object
    RoutingStrategyToolkitRatingType:
      description: Discriminator identifying a rating as a routing strategy toolkit rating.
      enum:
        - ToolkitRating
      type: string
      title: RoutingStrategyToolkitRatingType
    RoutingStrategyTransporter:
      properties:
        routingStrategies:
          items:
            $ref: '#/components/schemas/RoutingStrategy'
          type: array
        total:
          description: Total number of entities found for this query
          example: 42
          type: integer
      required:
        - routingStrategies
        - total
      type: object
      xml:
        name: RoutingStrategyTransporter
      title: RoutingStrategyTransporter
      description: RoutingStrategyTransporter
    SafetyStock:
      properties:
        created:
          format: date-time
          type: string
        facilityRef:
          type: string
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        tenantArticleId:
          type: string
        value:
          type: number
        version:
          type: number
      required:
        - tenantArticleId
        - value
        - created
        - id
        - lastModified
        - version
      title: SafetyStock
      type: object
      description: SafetyStock
    SafetyStockBulkOperation:
      properties:
        facilityRef:
          type: string
        tenantArticleId:
          type: string
        value:
          type: number
      required:
        - tenantArticleId
        - value
      title: SafetyStockBulkOperation
      type: object
      description: SafetyStockBulkOperation
    SafetyStockBulkOperationResult:
      properties:
        error:
          $ref: '#/components/schemas/BulkOperationError'
        facilityRef:
          type: string
        status:
          enum:
            - UPDATED
            - CREATED
            - FAILED
          type: string
        tenantArticleId:
          type: string
        value:
          type: number
      required:
        - tenantArticleId
        - facilityRef
        - value
        - status
      title: SafetyStockBulkOperationResult
      type: object
      description: SafetyStockBulkOperationResult
    SafetyStockBulkOperations:
      properties:
        operations:
          items:
            $ref: '#/components/schemas/SafetyStockBulkOperation'
          maxItems: 500
          minItems: 1
          type: array
      required:
        - operations
      title: SafetyStockBulkOperations
      type: object
      description: SafetyStockBulkOperations
    SafetyStocksPaginatedResult:
      properties:
        safetyStocks:
          items:
            $ref: '#/components/schemas/SafetyStock'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - safetyStocks
      title: SafetyStocksPaginatedResult
      type: object
      description: SafetyStocksPaginatedResult
    ScannableIdentifier:
      properties:
        identifiers:
          items:
            type: string
          maxItems: 10
          minItems: 1
          type: array
        searchType:
          enum:
            - PREFIX
            - SUFFIX
            - CONTAINS
          type: string
      required:
        - identifiers
      title: ScannableIdentifier
      type: object
      description: ScannableIdentifier
    ScanningRuleConfiguration:
      description: >-
        Configuration to show the client how the items should be scanned during
        picking
      properties:
        values:
          items:
            $ref: '#/components/schemas/ScanningRuleValue'
          type: array
      title: ScanningRuleConfiguration
    ScanningRuleTypeEnum:
      description: Type of scanning rule
      enum:
        - ARTICLE
        - LOCATION
      example: ARTICLE
      type: string
      title: ScanningRuleTypeEnum
    ScanningRuleValue:
      properties:
        priority:
          description: >-
            This field allows you to rank scanningRuleType against each other.
            The lowest number is the most preferable.
          minimum: 0
          type: number
        scanningRuleType:
          $ref: '#/components/schemas/ScanningRuleTypeEnum'
      required:
        - priority
        - scanningRuleType
      type: object
      title: ScanningRuleValue
      description: ScanningRuleValue
    ScheduledPickJobReleaseConfiguration:
      properties:
        openPickJobLeadTimeInMinutes:
          description: >-
            This config describes when a scheduled PickJob should be released
            and made available for picking (pickjob.pickingTimes.latest -
            openPickJobLeadTimeInMinutes = time when the PickJob should be
            released).
          type: integer
      required:
        - openPickJobLeadTimeInMinutes
      type: object
      title: ScheduledPickJobReleaseConfiguration
      description: ScheduledPickJobReleaseConfiguration
    ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - ACTIVE
              - INACTIVE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - ACTIVE
            - INACTIVE
          type: string
      title: ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter
      type: object
      description: ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter
    ScopedAvailabilityConfigPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        scopedAvailabilityConfigs:
          items:
            $ref: '#/components/schemas/InventoryArticleAvailabilityChangedEventScope'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - scopedAvailabilityConfigs
      title: ScopedAvailabilityConfigPaginatedResult
      type: object
      description: ScopedAvailabilityConfigPaginatedResult
    ScopedAvailabilityConfigSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ScopedAvailabilityConfigSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ScopedAvailabilityConfigSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ScopedAvailabilityConfigSearchPayload
      type: object
      description: ScopedAvailabilityConfigSearchPayload
    ScopedAvailabilityConfigSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ScopedAvailabilityConfigSearchQuery'
          maxItems: 500
          type: array
        facilityGroupRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by facilityGroupRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        facilityRefs:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by facilityRefs
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        key:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by key
        or:
          items:
            $ref: '#/components/schemas/ScopedAvailabilityConfigSearchQuery'
          maxItems: 500
          type: array
        status:
          allOf:
            - $ref: >-
                #/components/schemas/ScopedAvailabilityConfigEventScopeConfigStatusEnumFilter
          description: Search by status
      title: ScopedAvailabilityConfigSearchQuery
      type: object
      description: ScopedAvailabilityConfigSearchQuery
    ScopedAvailabilityConfigSort:
      properties:
        id:
          enum:
            - ASC
            - DESC
          type: string
        key:
          enum:
            - ASC
            - DESC
          type: string
      title: ScopedAvailabilityConfigSort
      type: object
      description: ScopedAvailabilityConfigSort
    ScopedCapability:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        configurations:
          items:
            anyOf:
              - $ref: '#/components/schemas/CarrierConfiguration'
              - $ref: '#/components/schemas/SubstitutionConfiguration'
              - $ref: '#/components/schemas/RerouteShortPickConfiguration'
              - $ref: '#/components/schemas/ReturnNoteConfiguration'
          type: array
        currentUserPermissions:
          items:
            type: string
          type: array
        name:
          type: string
        status:
          $ref: '#/components/schemas/CapabilityStatus'
      required:
        - name
        - status
      type: object
      title: ScopedCapability
      description: ScopedCapability
    Score:
      properties:
        scoreName:
          $ref: '#/components/schemas/ScoreName'
        scoreType:
          $ref: '#/components/schemas/ScoreType'
        scoreValue:
          description: Describes the performance of the score
          type: number
      required:
        - scoreType
        - scoreName
        - scoreValue
      type: object
      xml:
        name: Score
      title: Score
      description: Score
    ScoreName:
      description: Describes the name of the score for humans to identify
      enum:
        - ZONE
        - EXPIRY_DATE
        - RECEIPT_DATE
        - RUNNING_SEQUENCE
        - RESTOW_SEQUENCE
      type: string
      xml:
        name: ScoreName
      title: ScoreName
    ScoreType:
      description: Describes what kind of score is represented
      enum:
        - RATING
        - SEQUENCE
      type: string
      xml:
        name: ScoreType
      title: ScoreType
    SearchFilter:
      properties:
        like:
          description: Search by regex pattern
          maxLength: 256
          type: string
      title: SearchFilter
      type: object
      description: SearchFilter
    SearchOptions:
      properties:
        withTotal:
          description: >-
            Set to true to include the total count of items in the search
            result.
          type: boolean
      title: SearchOptions
      type: object
      description: SearchOptions
    SearchTrackingStatus:
      description: >-
        The state of the KEP, the same as TrackingStatus enum but in uppercase,
        it is used for Search Filters
      enum:
        - REGISTERED
        - PICKED_UP
        - DELIVERED
        - NOT_DELIVERED
        - TRANSIT
        - EXCEPTION
        - OUT_FOR_DELIVERY
        - DESTROYED
        - UNKNOWN
        - CANCELED
        - AWAITS_PICKUP_BY_RECEIVER
        - DELAYED
        - NOTIFICATION
      title: SearchTrackingStatus
      type: string
    Section:
      enum:
        - ORDER
        - PACKJOB
        - PICKJOB
        - HANDOVERJOB
        - PARCEL
        - PACKING_TARGET_CONTAINER
      type: string
      title: Section
      description: Section
    ServiceContainer:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the service job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        description:
          description: >-
            Translated description, filled on request based on
            descriptionLocalized.
          example: A medium-sized red box
          minLength: 1
          type: string
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        facilityRef:
          description: Id of the facility this container is used in.
          example: ba095e30-879f-11ee-b9d1-0242ac120002
          minLength: 1
          type: string
        iconUrl:
          description: URL to an icon representing this container type.
          example: https://example.com/icon.png
          minLength: 1
          type: string
        id:
          description: >-
            The id of this entity. It is generated during creation automatically
            and suits as the primary identifier of the described entity.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        lineItems:
          description: Items contained in this service container
          items:
            $ref: '#/components/schemas/ServiceContainerLineItem'
          maxItems: 50
          type: array
        name:
          description: Translated name, filled on request based on nameLocalized.
          example: Red Box
          minLength: 1
          type: string
        operativeContainerTypeRef:
          description: >-
            Reference to the operative container type this container is based
            on.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        operativeProcessRef:
          description: Reference to related operative process
          example: 019f5b8e-d580-767f-a28d-3fe569bd0064
          minLength: 1
          type: string
        previousModuleContainerInfo:
          $ref: '#/components/schemas/PreviousModuleContainerInfo'
        scannableCodes:
          description: Codes that can be used for scanning this container.
          example:
            - AB-123456
          items:
            type: string
          maxItems: 50
          type: array
        sequenceNumber:
          description: >-
            Incremental number to distinguish containers of the same type.
            Virtual container's sequenceNumber is always 0, non virtual
            containers are always greater than 0.
          example: 42
          type: integer
        serviceJobRefs:
          description: Ids of the ServiceJobs this container belongs to.
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 50
          type: array
        stackRef:
          description: Reference to related stack
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        status:
          default: AVAILABLE
          description: >-
            The status of the service container. It can be AVAILABLE or
            OBSOLETE. The status cannot be set from outside. When a service
            container is created, it is automatically set to AVAILABLE. When a
            service container is deleted, it is automatically set to OBSOLETE.
          enum:
            - AVAILABLE
            - OBSOLETE
          example: AVAILABLE
          type: string
        storageLocationRef:
          description: Id of the storage location this container is located at.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        type:
          description: Type of this service container
          enum:
            - VIRTUAL
            - PHYSICAL
          example: DEFAULT
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        weightLimitInG:
          description: Weight limit of the container in grams.
          example: 5000
          minimum: 0
          type: integer
      required:
        - serviceJobRefs
        - lineItems
        - nameLocalized
        - created
        - lastModified
        - version
        - id
        - facilityRef
        - type
        - status
      title: ServiceContainer
      type: object
      description: ServiceContainer
    ServiceContainerForCreation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        customAttributes:
          description: >-
            Attributes that can be added to the service job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        dimensions:
          $ref: '#/components/schemas/ContainerDimensions'
        iconUrl:
          description: URL to an icon representing this container type.
          example: https://example.com/icon.png
          minLength: 1
          type: string
        lineItems:
          description: Items contained in this service container
          items:
            $ref: '#/components/schemas/ServiceContainerLineItemForCreation'
          maxItems: 50
          type: array
        operativeContainerTypeRef:
          description: >-
            Reference to the operative container type this container is based
            on.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        previousModuleContainerInfo:
          $ref: '#/components/schemas/PreviousModuleContainerInfo'
        scannableCodes:
          description: Codes that can be used for scanning this container.
          example:
            - AB-123456
          items:
            type: string
          maxItems: 50
          type: array
        sequenceNumber:
          description: >-
            Incremental number to distinguish containers of the same type.
            Virtual container's sequenceNumber is always 0, non virtual
            containers are always greater than 0.
          example: 42
          type: integer
        serviceJobRefs:
          description: Ids of the ServiceJobs this container belongs to.
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 50
          type: array
        stackRef:
          description: Reference to related stack
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          minLength: 1
          type: string
        storageLocationRef:
          description: Id of the storage location this container is located at.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        weightLimitInG:
          description: Weight limit of the container in grams.
          example: 5000
          minimum: 0
          type: integer
      required:
        - serviceJobRefs
        - lineItems
      title: ServiceContainerForCreation
      type: object
      description: ServiceContainerForCreation
    ServiceContainerLineItem:
      properties:
        article:
          $ref: '#/components/schemas/LineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            Cross-entity identifier linking this line item back to the
            originating pick line item.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        id:
          description: id line item
          example: 17ebfdfb-e1b4-4913-9962-3aef2b49f16f
          minLength: 1
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened. This can be used to restore the ‘pre-split’
            status.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          minLength: 1
          nullable: true
          type: string
        quantity:
          description: The quantity of the lineItem
          example: 5
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          maxItems: 50
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          example:
            - AB-123456
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            Secondary quantity of the items, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 100
          minimum: 0
          type: integer
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 50
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 50
          type: array
      required:
        - article
        - globalLineItemId
        - quantity
        - id
      title: ServiceContainerLineItem
      type: object
      description: ServiceContainerLineItem
    ServiceContainerLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/LineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          minLength: 1
          type: string
        quantity:
          description: The quantity of the lineItem
          example: 5
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 50
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 50
          type: array
      required:
        - article
        - quantity
      title: ServiceContainerLineItemForCreation
      type: object
      description: ServiceContainerLineItemForCreation
    ServiceContainers:
      properties:
        serviceContainers:
          description: List of service containers matching the query
          items:
            $ref: '#/components/schemas/ServiceContainer'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      title: ServiceContainers
      type: object
      description: ServiceContainers
    ServiceContainerWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ServiceContainer'
      required:
        - payload
      type: object
      title: ServiceContainerWebHookEvent
      description: ServiceContainerWebHookEvent
    ServiceData:
      properties:
        availableLineItems:
          description: Information about the items that are available for the service job.
          items:
            $ref: '#/components/schemas/ServiceDataAvailableLineItem'
          maxItems: 200
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          description: ID of the Service Data
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        serviceJobRefs:
          description: IDs of all serviceJobs connected to this service data
          example:
            - cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05
          items:
            type: string
          maxItems: 50
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - serviceJobRefs
        - availableLineItems
        - created
        - lastModified
        - version
        - id
      title: ServiceData
      type: object
      description: ServiceData
    ServiceDataAvailableLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceDataItemArticle'
          description: Article information for this available line item
        availableQuantity:
          description: Quantity of the item that is available
          example: 12
          minimum: 0
          type: integer
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        executedServiceJobData:
          description: History of service jobs that have processed this available line item
          items:
            $ref: '#/components/schemas/ServiceDataExecutedServiceJobs'
          maxItems: 50
          type: array
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: ID of the available line item
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened. This can be used to restore the 'pre-split'
            status.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          minLength: 1
          nullable: true
          type: string
        quantity:
          description: The quantity of the lineItem
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - id
        - article
        - quantity
        - availableQuantity
        - executedServiceJobData
      title: ServiceDataAvailableLineItem
      type: object
      description: ServiceDataAvailableLineItem
    ServiceDataAvailableLineItemForCreation:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceDataItemArticle'
          description: Article information for this available line item
        availableQuantity:
          description: Quantity of the item that is available
          example: 12
          minimum: 0
          type: integer
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        executedServiceJobData:
          description: History of service jobs that have processed this available line item
          items:
            $ref: '#/components/schemas/ServiceDataExecutedServiceJobs'
          maxItems: 50
          type: array
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened. This can be used to restore the 'pre-split'
            status.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          minLength: 1
          nullable: true
          type: string
        quantity:
          description: The quantity of the lineItem
          example: 12
          minimum: 0
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          maxItems: 50
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - article
        - quantity
        - availableQuantity
        - executedServiceJobData
      title: ServiceDataAvailableLineItemForCreation
      type: object
      description: ServiceDataAvailableLineItemForCreation
    ServiceDataAvailableLineItemForUpdate:
      properties:
        availableQuantity:
          description: Available quantity of the items
          example: 10
          minimum: 0
          type: integer
        executedServiceJobData:
          description: Updated history of service jobs that have processed this line item
          items:
            $ref: '#/components/schemas/ServiceDataExecutedServiceJobs'
          maxItems: 50
          type: array
        id:
          description: ID of the available line item to update
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        quantity:
          description: Quantity of the items
          example: 5
          minimum: 0
          type: integer
      required:
        - id
      title: ServiceDataAvailableLineItemForUpdate
      type: object
      description: ServiceDataAvailableLineItemForUpdate
    ServiceDataExecutedServiceJobs:
      properties:
        appliedQuantity:
          description: Quantity of the item that has been selected from this service job
          example: 0
          minimum: 0
          type: integer
        itemsReturnable:
          description: >-
            Indicates if the item is returnable based on the used service job
            definition while adding the items
          example: true
          type: boolean
        sequence:
          description: >-
            sequence in which this service job has been executed for this line
            item. the lower, the earlier it has been executed.
          example: 1
          minimum: 1
          type: integer
        serviceJobRef:
          description: >-
            Id of the Service Job, that has been applied to the
            ServiceDataAvailableLineItem.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
      required:
        - serviceJobRef
        - sequence
        - appliedQuantity
        - itemsReturnable
      title: ServiceDataExecutedServiceJobs
      type: object
      description: ServiceDataExecutedServiceJobs
    ServiceDataItemArticle:
      properties:
        titleLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations for the title of the product
        attributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 200
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Ensure that no
            authentication is needed to fetch the image.
          example: https://example.com/resource
          type: string
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          description: Weight value is in gram
          minimum: 0
          type: number
      required:
        - tenantArticleId
        - title
      title: ServiceDataItemArticle
      type: object
      description: ServiceDataItemArticle
    ServiceItemInfo:
      properties:
        quantity:
          description: Quantity of the item to be (un-)selected).
          example: 1
          minimum: 1
          type: integer
        serviceItemRef:
          description: Id of the ServiceItem to be (un-)selected).
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
      required:
        - serviceItemRef
        - quantity
      title: ServiceItemInfo
      type: object
      description: ServiceItemInfo
    ServiceItemSelectQuantityActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'SELECT_ITEMS_FOR_SERVICE_JOB'
          enum:
            - SELECT_ITEMS_FOR_SERVICE_JOB
          example: SELECT_ITEMS_FOR_SERVICE_JOB
          type: string
        serviceItemsToSelect:
          description: Service items that are selected to be used in the service job
          items:
            $ref: '#/components/schemas/ServiceItemInfo'
          maxItems: 50
          minItems: 1
          type: array
        serviceJobVersion:
          description: Version of the service job
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - serviceItemsToSelect
        - serviceJobVersion
      title: ServiceItemSelectQuantityActionParameter
      type: object
      description: ServiceItemSelectQuantityActionParameter
    ServiceItemUnselectQuantityActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'UNSELECT_ITEMS_FOR_SERVICE_JOB'
          enum:
            - UNSELECT_ITEMS_FOR_SERVICE_JOB
          example: UNSELECT_ITEMS_FOR_SERVICE_JOB
          type: string
        serviceItemsToUnselect:
          description: Service items that are unselected from being used in the service job
          items:
            $ref: '#/components/schemas/ServiceItemInfo'
          maxItems: 50
          minItems: 1
          type: array
        serviceJobVersion:
          description: Version of the service job
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - serviceItemsToUnselect
        - serviceJobVersion
      title: ServiceItemUnselectQuantityActionParameter
      type: object
      description: ServiceItemUnselectQuantityActionParameter
    ServiceJob:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        additionalInformation:
          description: Additional information collected for this service job
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformation'
          maxItems: 15
          type: array
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        assignedUsers:
          description: Assigned users for this entity
          items:
            $ref: '#/components/schemas/AssignedUser'
          maxItems: 10
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the service job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        customServiceRef:
          description: Id of the customService this ServiceJob was created from.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        description:
          description: >-
            Translated description of this service job derived from
            descriptionLocalized
          example: Wrapping 3 gifts for order ocff-order-100
          type: string
        editor:
          $ref: '#/components/schemas/Editor'
        executionTimeInMin:
          description: Time in minutes this service job is expected to take to be executed
          example: 60
          minimum: 0
          type: integer
        facilityRef:
          description: ID of the Facility, the Service Job is executed in.
          example: ba095e30-879f-11ee-b9d1-0242ac120002
          type: string
        id:
          description: Unique ID of this service job
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        imageRefs:
          description: List of linked images taken from the connected custom service
          example:
            - https://my-image-host.com/images/custom-service-1.jpg
          items:
            type: string
          maxItems: 50
          type: array
        inheritedLineItems:
          deprecated: true
          description: 'deprecated: use availableLineItems on ServiceData instead'
          items:
            $ref: '#/components/schemas/InheritedServiceJobLineItem'
          maxItems: 200
          type: array
        itemsRequired:
          description: Indicates whether items are required for executing this service job
          enum:
            - MANDATORY
            - NONE
          example: OPTIONAL
          type: string
        itemsReturnable:
          description: >-
            Indicates if the items worked on in this service job are returnable
            after execution
          example: false
          type: boolean
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        lineItems:
          description: Items to be processed as part of this service job
          items:
            $ref: '#/components/schemas/ServiceJobLineItem'
          maxItems: 50
          type: array
        linkedServiceJobsRef:
          description: ID of the Linked Service Job, the Service Job should reference.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        name:
          description: Translated name of this service job derived from nameLocalized
          example: Gift Wrapping Job
          type: string
        operativeProcessRef:
          description: Reference to the operative process this service job is part of
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          type: string
        processRef:
          description: ID of the process this service job belongs to
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        requiredLineItems:
          description: Information about the items that are required
          items:
            $ref: '#/components/schemas/RequiredLineItem'
          maxItems: 50
          type: array
        serviceJobLinkRef:
          description: ID of the Service Job Link, the Service Job should reference.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        shortId:
          description: Short human-readable identifier for this service job
          example: KD-12-1
          type: string
        status:
          description: Current status of this service job
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - WAITING_FOR_INPUT
            - OBSOLETE
            - NOT_READY
          example: OPEN
          type: string
        statusInformation:
          allOf:
            - $ref: '#/components/schemas/ServiceJobStatusInformation'
          description: Additional information about the current status of this service job
        subStatus:
          description: Additional sub-status information about this service job
          enum:
            - LINE_ITEMS_MISSING
            - REQUIRED_LINE_ITEMS_UNFULFILLABLE
          example: WAITING_FOR_INPUT
          type: string
        targetTime:
          description: At which time the service job is expected to be finished.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        tenantCustomServiceId:
          description: >-
            Tenant ID of the Custom Service, the Service Job should reference.
            Either this and/or the customServiceRef must passed.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        tenantOrderId:
          description: ID of the tenant order, the linked service jobs are part of
          example: ocff-order-100
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - customServiceRef
        - processRef
        - facilityRef
        - lineItems
        - targetTime
        - created
        - lastModified
        - version
        - id
        - status
        - nameLocalized
        - itemsRequired
      title: ServiceJob
      type: object
      description: ServiceJob
    ServiceJobAdditionalInformation:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        description:
          description: Translated description of this additional information
          example: Please describe the damage in detail
          minLength: 1
          type: string
        id:
          description: Unique ID of this additional information entry
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        isMandatory:
          description: Indicates if filling in this additional information is mandatory
          example: false
          type: boolean
        name:
          description: Translated name of this additional information
          example: Damage Description
          minLength: 1
          type: string
        tenantAdditionalInformationId:
          description: >-
            External ID referencing this additional information in the tenant
            system
          example: ADD_INFO_1
          minLength: 1
          type: string
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
          description: Value of the additional information
          example: some value
        valueType:
          description: Type of the value stored in this additional information
          enum:
            - STRING
            - BOOLEAN
            - NUMBER
            - NOVALUE
            - INPUT_MULTILINE_STRING
          example: STRING
          type: string
      required:
        - nameLocalized
        - valueType
        - id
      title: ServiceJobAdditionalInformation
      type: object
      description: ServiceJobAdditionalInformation
    ServiceJobAdditionalInformationForCreation:
      properties:
        additionalInformationRef:
          description: >-
            ID of the additional information. Either
            tenantAdditionalInformationId or additionalInformationRef must be
            set.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        tenantAdditionalInformationRef:
          description: >-
            external ID of the additional information. Either
            tenantAdditionalInformationId or additionalInformationRef must be
            set.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
          description: Value of the additional information
          example: some value
      title: ServiceJobAdditionalInformationForCreation
      type: object
      description: ServiceJobAdditionalInformationForCreation
    ServiceJobAdditionalInformationForUpdate:
      properties:
        additionalInformationRef:
          description: ID of the additional information
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        tenantAdditionalInformationRef:
          description: external ID of the additional information
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
          description: Value of the additional information
          example: some value
      title: ServiceJobAdditionalInformationForUpdate
      type: object
      description: ServiceJobAdditionalInformationForUpdate
    ServiceJobAddTargetTimeActionParameter:
      properties:
        name:
          description: Name of the action to perform, must be 'ADD_TARGET_TIME'
          enum:
            - ADD_TARGET_TIME
          example: ADD_TARGET_TIME
          type: string
        targetTime:
          description: >-
            TargetTime you want to set for given ServiceJob. If the ServiceJob
            already has a TargetTime, this Action will fail.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        version:
          description: Version of the service job
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - version
        - targetTime
      title: ServiceJobAddTargetTimeActionParameter
      type: object
      description: ServiceJobAddTargetTimeActionParameter
    ServiceJobCancelledActionParameter:
      properties:
        additionalInformation:
          description: Additional information updates to apply along with the action
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate'
          maxItems: 15
          type: array
        cancelReason:
          $ref: '#/components/schemas/LocaleString'
        name:
          description: Name of the action to perform, must be 'CancelServiceJob'
          enum:
            - CancelServiceJob
          example: CancelServiceJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: ServiceJobCancelledActionParameter
      type: object
      description: ServiceJobCancelledActionParameter
    ServiceJobCancelReason:
      properties:
        cancelReasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          description: >-
            Indicates if this cancel reason is currently active and can be
            selected
          example: true
          type: boolean
        cancelReason:
          description: translated cancelReason selected from cancelReasonLocalized
          example: Broken Item
          minLength: 1
          type: string
      required:
        - active
        - cancelReasonLocalized
      title: ServiceJobCancelReason
      type: object
      description: ServiceJobCancelReason
    ServiceJobFinishedActionParameter:
      properties:
        additionalInformation:
          description: Additional information updates to apply along with the action
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate'
          maxItems: 15
          type: array
        name:
          description: Name of the action to perform, must be 'FinishServiceJob'
          enum:
            - FinishServiceJob
          example: FinishServiceJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: ServiceJobFinishedActionParameter
      type: object
      description: ServiceJobFinishedActionParameter
    ServiceJobForCreation:
      properties:
        additionalInformation:
          description: Additional information to be collected for this service job
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformationForCreation'
          maxItems: 15
          type: array
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          maxItems: 10
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the service job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        customServiceRef:
          description: >-
            ID of the Custom Service, the Service Job should reference. Either
            this and/or the tenantCustomServiceId must passed.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        facilityRef:
          description: ID of the Facility, the Service Job is executed in.
          example: ba095e30-879f-11ee-b9d1-0242ac120002
          type: string
        lineItems:
          description: Items to be processed as part of this service job
          items:
            $ref: '#/components/schemas/ServiceJobLineItemForCreation'
          maxItems: 50
          type: array
        operativeProcessRef:
          description: Reference to the operative process this service job is part of
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          type: string
        processRef:
          description: ID of the Process, the Service Job belongs to.
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        requiredLineItems:
          description: Information about the items that are required
          items:
            $ref: '#/components/schemas/RequiredLineItemForCreation'
          maxItems: 50
          type: array
        serviceJobLinkRef:
          description: ID of the Service Job Link, the Service Job should reference.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        shortId:
          description: Short human-readable identifier for this service job
          example: KD-12-1
          type: string
        targetTime:
          description: At which time the service job is expected to be finished.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        tenantCustomServiceId:
          description: >-
            Tenant ID of the Custom Service, the Service Job should reference.
            Either this and/or the customServiceRef must passed.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        tenantOrderId:
          description: ID of the tenant order, the linked service jobs are part of
          example: ocff-order-100
          type: string
      required:
        - facilityRef
        - targetTime
      title: ServiceJobForCreation
      type: object
      description: ServiceJobForCreation
    ServiceJobInProgressActionParameter:
      properties:
        additionalInformation:
          description: Additional information updates to apply along with the action
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate'
          maxItems: 15
          type: array
        name:
          description: Name of the action to perform, must be 'StartServiceJob'
          enum:
            - StartServiceJob
          example: StartServiceJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: ServiceJobInProgressActionParameter
      type: object
      description: ServiceJobInProgressActionParameter
    ServiceJobLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceJobLineItemArticle'
          description: Article information of this line item
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          description: Unique ID of this line item
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        originId:
          description: >-
            The id of the line item this line item was originated from, before
            any split has happened. This can be used to restore the ‘pre-split’
            status.
          example: df671041-10dd-4600-a2ff-e9ffe2556bba
          minLength: 1
          nullable: true
          type: string
        quantity:
          description: Quantity of the items
          example: 12
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      required:
        - id
        - article
        - quantity
      title: ServiceJobLineItem
      type: object
      description: ServiceJobLineItem
    ServiceJobLineItemArticle:
      properties:
        titleLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: The translations for the title of the product
        attributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          maxItems: 200
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this article. Ensure that no
            authentication is needed to fetch the image.
          example: https://example.com/resource
          type: string
        tenantArticleId:
          description: This is a reference to an article number
          example: '4711'
          type: string
        title:
          description: The title of the product
          example: Cologne Water
          type: string
        weight:
          description: Weight value is in gram
          minimum: 0
          type: number
      required:
        - tenantArticleId
        - title
      title: ServiceJobLineItemArticle
      type: object
      description: ServiceJobLineItemArticle
    ServiceJobLineItemForCreation:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/ServiceJobLineItemArticle'
          description: Article information of this line item
        customAttributes:
          description: >-
            Attributes that can be added to the lineItem. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        globalLineItemId:
          description: >-
            This ID is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        measurementUnitKey:
          description: Measurement unit key of the item, for example "pcs" or "kg"
          example: pcs
          minLength: 1
          type: string
        quantity:
          description: Quantity of the items
          example: 12
          minimum: 1
          type: integer
        recordableAttributes:
          description: >-
            Customizable information about the lineItem that can be set during
            the process.
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          type: array
        scannableCodes:
          description: Codes that can be used for scanning this lineItem
          items:
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: g
          minLength: 1
          type: string
        secondaryQuantity:
          description: >-
            secondary quantity of this item, e.g. quantity is the count and
            secondaryQuantity is the weight
          example: 42
          minimum: 0
          type: number
      title: ServiceJobLineItemForCreation
      type: object
      description: ServiceJobLineItemForCreation
    ServiceJobLink:
      properties:
        id:
          description: Unique ID of this service job link
          example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad
          minLength: 1
          type: string
        nextServiceJobLinks:
          description: Links to the next service jobs in the execution chain
          items:
            $ref: '#/components/schemas/ServiceJobLink'
          maxItems: 50
          minItems: 0
          type: array
        previousServiceJobLinkRefs:
          description: id of the created previous service job links
          example:
            - 9f197dbf-c724-469b-90f1-dc94f20b2825
          items:
            type: string
          maxItems: 1
          minItems: 0
          type: array
        previousServiceJobRefs:
          description: >-
            IDs of the preceding service job links that must be completed before
            this one
          example:
            - 9f197dbf-c724-469b-90f1-dc94f20b2825
          items:
            type: string
          maxItems: 1
          minItems: 0
          type: array
        serviceJobRef:
          description: ID of the service job this link references
          example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad
          minLength: 1
          type: string
      required:
        - serviceJobRef
        - previousServiceJobRefs
        - nextServiceJobLinks
        - id
        - previousServiceJobLinkRefs
      title: ServiceJobLink
      type: object
      description: ServiceJobLink
    ServiceJobLinkForAdding:
      properties:
        serviceJobRef:
          description: ID of the service job to add to this linked service jobs group
          example: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad
          minLength: 1
          type: string
      required:
        - serviceJobRef
      title: ServiceJobLinkForAdding
      type: object
      description: ServiceJobLinkForAdding
    ServiceJobLogCancellationPayload:
      allOf:
        - $ref: '#/components/schemas/ServiceJobLogPayload'
      properties:
        statusInformationCancelReason:
          $ref: '#/components/schemas/ServiceJobStatusReason'
      type: object
      title: ServiceJobLogCancellationPayload
      description: ServiceJobLogCancellationPayload
    ServiceJobLogPayload:
      allOf:
        - $ref: '#/components/schemas/OperativeEntityPayloadBase'
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        name:
          type: string
      type: object
      title: ServiceJobLogPayload
      description: ServiceJobLogPayload
    ServiceJobObsoleteActionParameter:
      properties:
        name:
          description: Name of the action to perform, must be 'ObsoleteServiceJob'
          enum:
            - ObsoleteServiceJob
          example: ObsoleteServiceJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: ServiceJobObsoleteActionParameter
      type: object
      description: ServiceJobObsoleteActionParameter
    ServiceJobOpenActionParameter:
      properties:
        additionalInformation:
          description: Additional information updates to apply along with the action
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate'
          maxItems: 15
          type: array
        name:
          description: Name of the action to perform, must be 'OpenServiceJob'
          enum:
            - OpenServiceJob
          example: OpenServiceJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: ServiceJobOpenActionParameter
      type: object
      description: ServiceJobOpenActionParameter
    ServiceJobReplaceAssignedUsersActionParameter:
      properties:
        assignedUsers:
          description: Assigned users for this entity
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUserForCreationById'
          maxItems: 10
          type: array
        name:
          description: Name of the action to perform, must be 'REPLACE_ASSIGNED_USERS'
          enum:
            - REPLACE_ASSIGNED_USERS
          example: REPLACE_ASSIGNED_USERS
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
        - assignedUsers
      title: ServiceJobReplaceAssignedUsersActionParameter
      type: object
      description: ServiceJobReplaceAssignedUsersActionParameter
    ServiceJobs:
      properties:
        serviceJobs:
          description: List of service jobs matching the query
          items:
            $ref: '#/components/schemas/ServiceJobWithSearchPaths'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      title: ServiceJobs
      type: object
      description: ServiceJobs
    ServiceJobSplitLineItemsActionParameter:
      properties:
        name:
          description: Name of the action to perform, must be 'SPLIT_LINES_SERVICE_JOB'
          enum:
            - SPLIT_LINES_SERVICE_JOB
          example: SPLIT_LINES_SERVICE_JOB
          type: string
        splitLineItemsInfo:
          description: >-
            List of line item splits to perform, each specifying a line item and
            its new quantity
          items:
            $ref: '#/components/schemas/ServiceJobSplitLineItemsInfo'
          maxItems: 50
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
        - splitLineItemsInfo
      title: ServiceJobSplitLineItemsActionParameter
      type: object
      description: ServiceJobSplitLineItemsActionParameter
    ServiceJobSplitLineItemsInfo:
      properties:
        lineItemId:
          description: references the id of the lineItem of a serviceJob
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        quantity:
          description: quantity of the specific item that has been ordered
          example: 21
          minimum: 1
          type: integer
      required:
        - lineItemId
        - quantity
      title: ServiceJobSplitLineItemsInfo
      type: object
      description: ServiceJobSplitLineItemsInfo
    ServiceJobStatusInformation:
      properties:
        cancelReason:
          allOf:
            - $ref: '#/components/schemas/StatusReason'
          description: Reason provided when this service job was cancelled
      title: ServiceJobStatusInformation
      type: object
      description: ServiceJobStatusInformation
    ServiceJobStatusReason:
      additionalProperties: false
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        reason:
          type: string
      required:
        - reasonLocalized
      type: object
      title: ServiceJobStatusReason
      description: ServiceJobStatusReason
    ServiceJobWaitingForInputActionParameter:
      properties:
        additionalInformation:
          description: Additional information updates to apply along with the action
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformationForUpdate'
          maxItems: 15
          type: array
        name:
          description: Name of the action to perform, must be 'HoldServiceJob'
          enum:
            - HoldServiceJob
          example: HoldServiceJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: ServiceJobWaitingForInputActionParameter
      type: object
      description: ServiceJobWaitingForInputActionParameter
    ServiceJobWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ServiceJob'
      required:
        - payload
      type: object
      title: ServiceJobWebHookEvent
      description: ServiceJobWebHookEvent
    ServiceJobWithSearchPaths:
      properties:
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        additionalInformation:
          description: Additional information collected for this service job
          items:
            $ref: '#/components/schemas/ServiceJobAdditionalInformation'
          maxItems: 15
          type: array
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        assignedUsers:
          description: Assigned users for this entity
          items:
            $ref: '#/components/schemas/AssignedUser'
          maxItems: 10
          type: array
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the service job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
          type: object
        customServiceRef:
          description: Id of the customService this ServiceJob was created from.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        description:
          description: >-
            Translated description of this service job derived from
            descriptionLocalized
          example: Wrapping 3 gifts for order ocff-order-100
          type: string
        editor:
          $ref: '#/components/schemas/Editor'
        executionTimeInMin:
          description: Time in minutes this service job is expected to take to be executed
          example: 60
          minimum: 0
          type: integer
        facilityRef:
          description: ID of the Facility, the Service Job is executed in.
          example: ba095e30-879f-11ee-b9d1-0242ac120002
          type: string
        id:
          description: Unique ID of this service job
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          minLength: 1
          type: string
        imageRefs:
          description: List of linked images taken from the connected custom service
          example:
            - https://my-image-host.com/images/custom-service-1.jpg
          items:
            type: string
          maxItems: 50
          type: array
        inheritedLineItems:
          deprecated: true
          description: 'deprecated: use availableLineItems on ServiceData instead'
          items:
            $ref: '#/components/schemas/InheritedServiceJobLineItem'
          maxItems: 200
          type: array
        itemsRequired:
          description: Indicates whether items are required for executing this service job
          enum:
            - MANDATORY
            - NONE
          example: OPTIONAL
          type: string
        itemsReturnable:
          description: >-
            Indicates if the items worked on in this service job are returnable
            after execution
          example: false
          type: boolean
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        lineItems:
          description: Items to be processed as part of this service job
          items:
            $ref: '#/components/schemas/ServiceJobLineItem'
          maxItems: 50
          type: array
        linkedServiceJobsRef:
          description: ID of the Linked Service Job, the Service Job should reference.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        name:
          description: Translated name of this service job derived from nameLocalized
          example: Gift Wrapping Job
          type: string
        operativeProcessRef:
          description: Reference to the operative process this service job is part of
          example: 9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1
          type: string
        processRef:
          description: ID of the process this service job belongs to
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        requiredLineItems:
          description: Information about the items that are required
          items:
            $ref: '#/components/schemas/RequiredLineItem'
          maxItems: 50
          type: array
        searchPaths:
          description: Search paths used for full-text search indexing of this entity
          items:
            type: string
          maxItems: 200
          type: array
        serviceJobLinkRef:
          description: ID of the Service Job Link, the Service Job should reference.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        shortId:
          description: Short human-readable identifier for this service job
          example: KD-12-1
          type: string
        status:
          description: Current status of this service job
          enum:
            - OPEN
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - WAITING_FOR_INPUT
            - OBSOLETE
            - NOT_READY
          example: OPEN
          type: string
        statusInformation:
          allOf:
            - $ref: '#/components/schemas/ServiceJobStatusInformation'
          description: Additional information about the current status of this service job
        subStatus:
          description: Additional sub-status information about this service job
          enum:
            - LINE_ITEMS_MISSING
            - REQUIRED_LINE_ITEMS_UNFULFILLABLE
          example: WAITING_FOR_INPUT
          type: string
        targetTime:
          description: At which time the service job is expected to be finished.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        tenantCustomServiceId:
          description: >-
            Tenant ID of the Custom Service, the Service Job should reference.
            Either this and/or the customServiceRef must passed.
          example: 41d43211-g5a1-gg22-a716-ba095e30ds1d
          type: string
        tenantOrderId:
          description: ID of the tenant order, the linked service jobs are part of
          example: ocff-order-100
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - customServiceRef
        - processRef
        - facilityRef
        - lineItems
        - targetTime
        - created
        - lastModified
        - version
        - id
        - status
        - nameLocalized
        - itemsRequired
        - searchPaths
      title: ServiceJobWithSearchPaths
      type: object
      description: ServiceJobWithSearchPaths
    SetHandoverJobToWaitingForInputActionEnum:
      enum:
        - WAITING_FOR_INPUT
      type: string
      title: SetHandoverJobToWaitingForInputActionEnum
      description: SetHandoverJobToWaitingForInputActionEnum
    SetHandoverJobToWaitingForInputActionParameter:
      additionalProperties: false
      description: Action to set a handoverjob to waiting for input.
      properties:
        name:
          $ref: '#/components/schemas/SetHandoverJobToWaitingForInputActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
      title: SetHandoverJobToWaitingForInputActionParameter
    SevenSendersCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        trackAndTraceUrl:
          description: Track and trace URL
          example: https://example.com/resource
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
        warehouse:
          description: Warehouse identifier
          type: string
      required:
        - version
        - carrierRef
        - returnLabel
      title: SevenSendersCarrierConfiguration
      type: object
      description: SevenSendersCarrierConfiguration
    SftpConfiguration:
      properties:
        useSftpForTandT:
          description: Indicates if the carrier uses sftp for getting track and trace data
          type: boolean
      required:
        - useSftpForTandT
      title: SftpConfiguration
      type: object
      description: SftpConfiguration
    ShipFromStoreRerouteConfiguration:
      properties:
        active:
          type: boolean
        allowManualReroute:
          default: false
          deprecated: true
          description: >-
            @deprecated This config property is deprecated since 26/02/24. Use
            GlobalManualRerouteConfiguration instead.
          type: boolean
        facilityWideRerouteOnShortPick:
          default: false
          type: boolean
        rerouteTargetTime:
          description: >-
            Only pickJobs where the targetTime in not larger than now plus this
            number are rerouted
          example: '48'
          type: number
        rerouteType:
          $ref: '#/components/schemas/RerouteType'
      required:
        - active
        - rerouteType
      type: object
      title: ShipFromStoreRerouteConfiguration
      description: ShipFromStoreRerouteConfiguration
    Shipment:
      allOf:
        - $ref: '#/components/schemas/ShipmentForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            anonymized:
              default: false
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            carrierKey:
              example: DPD
              type: string
            hasActiveCarrier:
              default: true
              description: >-
                Indicates if there is an active carrier configuration to fulfill
                this shipment
              example: false
              type: boolean
            id:
              description: >-
                The id of this Shipment. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: 95EWrieX09OmeriXIUbb
              type: string
            lineItems:
              items:
                $ref: '#/components/schemas/ShipmentLineItem'
              type: array
            parcels:
              items:
                $ref: '#/components/schemas/StrippedParcel'
              type: array
            status:
              $ref: '#/components/schemas/ShipmentStatus'
            workflowInformation:
              oneOf:
                - $ref: '#/components/schemas/WorkflowInformation'
                - $ref: '#/components/schemas/WorkflowUnavailable'
          required:
            - id
            - status
            - hasActiveCarrier
            - workflowInformation
          type: object
      title: Shipment
      description: Shipment
    ShipmentActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/ShipmentSplitLineItemsActionParameter'
        - $ref: >-
            #/components/schemas/UpdateShipmentLineItemRecordableAttributesActionParameter
        - $ref: '#/components/schemas/ShipmentAddTargetTimeActionParameter'
      title: ShipmentActionsParameter
      description: ShipmentActionsParameter
    ShipmentAddTargetTimeActionEnum:
      enum:
        - ADD_TARGET_TIME
      type: string
      title: ShipmentAddTargetTimeActionEnum
      description: ShipmentAddTargetTimeActionEnum
    ShipmentAddTargetTimeActionParameter:
      additionalProperties: false
      description: >-
        Action to add targetTime to a Shipment that has none. Will fail if
        targetTime is already set
      properties:
        name:
          $ref: '#/components/schemas/ShipmentAddTargetTimeActionEnum'
        targetTime:
          description: The target time you want set for the given shipment.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
        - targetTime
      title: ShipmentAddTargetTimeActionParameter
      type: object
    ShipmentForCreation:
      additionalProperties: false
      properties:
        carrierLogoUrl:
          description: The URL to the carrier logo
          type: string
        carrierProduct:
          description: Desired product of given carrier to choose when ordering a label
          example: EXPRESS
          type: string
        carrierRef:
          description: The reference to the carrier for which the shipment is assigned to
          example: ca525716-7208-4a63-a2a6-11274eb37f67-0
          type: string
        carrierServices:
          items:
            $ref: '#/components/schemas/CarrierServices'
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the shipment. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        facilityRef:
          description: The reference to the facility which the shipment is assigned to.
          type: string
        invoiceAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        lineItems:
          items:
            $ref: '#/components/schemas/ShipmentLineItemForCreation'
          type: array
        operativeProcessRef:
          type: string
        orderDate:
          description: The date this order was created at the supplying system.
          format: date-time
          type: string
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        pickJobRef:
          description: The id of the facility reference.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        postalAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        processId:
          description: >-
            Id of the global process related to this entity. For example used
            for starting the GDPR process and others.
          type: string
        shortId:
          description: The short identifier of the shipment.
          type: string
        sourceAddress:
          $ref: '#/components/schemas/FacilityAddress'
        targetAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        targetTime:
          description: At which time the result is expected.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        targetTimeBaseDate:
          description: The start date for the targetTime calculation.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        tenantOrderId:
          description: Reference to the order in the tenant system.
          type: string
        transfers:
          items:
            $ref: '#/components/schemas/OperativeTransfer'
          minItems: 0
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - facilityRef
        - targetTime
        - orderDate
      type: object
      xml:
        name: Shipment
      title: ShipmentForCreation
      description: ShipmentForCreation
    ShipmentLineItem:
      allOf:
        - $ref: '#/components/schemas/ShipmentLineItemForCreation'
        - properties:
            id:
              description: >-
                The id of this lineItem. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: climk4dcQFiPdA5ULuhS
              type: string
            recordableAttributes:
              items:
                $ref: '#/components/schemas/RecordableAttribute'
              type: array
          required:
            - id
          type: object
      title: ShipmentLineItem
      description: ShipmentLineItem
    ShipmentLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              maxItems: 40
              type: array
          type: object
      xml:
        name: ShipmentLineItemArticle
      title: ShipmentLineItemArticle
      description: ShipmentLineItemArticle
    ShipmentLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/ShipmentLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to the orderline. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        quantity:
          description: quantity of the specific article that has been ordered
          example: 21
          format: int64
          minimum: 1
          type: integer
        recordableAttributes:
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          type: array
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
      required:
        - quantity
        - article
      type: object
      title: ShipmentLineItemForCreation
      description: ShipmentLineItemForCreation
    ShipmentOrderBy:
      description: STATUS_TARGET_TIME_LAST_MODIFIED_DATE is depricated
      enum:
        - STATUS_TARGET_TIME_ORDER_DATE
      title: ShipmentOrderBy
    ShipmentPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        shipments:
          items:
            $ref: '#/components/schemas/Shipment'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - shipments
      title: ShipmentPaginatedResult
      type: object
      description: ShipmentPaginatedResult
    ShipmentParcelsFilter:
      properties:
        status:
          allOf:
            - $ref: '#/components/schemas/ShipmentParcelsParcelStatusEnumFilter'
          description: Search by status
      title: ShipmentParcelsFilter
      type: object
      description: ShipmentParcelsFilter
    ShipmentParcelsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/ShipmentParcelsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ShipmentParcelsListFilter
      type: object
      description: ShipmentParcelsListFilter
    ShipmentParcelsParcelStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - PROCESSING
            - DONE
            - FAILED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - PROCESSING
              - DONE
              - FAILED
              - CANCELED
              - OBSOLETE
              - WAITING_FOR_INPUT
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - PROCESSING
            - DONE
            - FAILED
            - CANCELED
            - OBSOLETE
            - WAITING_FOR_INPUT
          type: string
      title: ShipmentParcelsParcelStatusEnumFilter
      type: object
      description: ShipmentParcelsParcelStatusEnumFilter
    ShipmentPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyShipment'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: ShipmentPatchActions
      title: ShipmentPatchActions
      description: ShipmentPatchActions
    ShipmentSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ShipmentSearchQueryWrapper'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ShipmentSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ShipmentSearchPayload
      type: object
      description: ShipmentSearchPayload
    ShipmentSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ShipmentSearchQuery'
          maxItems: 500
          type: array
        anonymized:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by anonymized
        carrierKey:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierKey
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/ShipmentSearchQuery'
          maxItems: 500
          type: array
        parcels:
          allOf:
            - $ref: '#/components/schemas/ShipmentParcelsListFilter'
          description: Nested list search by parcels
        pickJobRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by pickJobRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        status:
          allOf:
            - $ref: '#/components/schemas/ShipmentStatusEnumFilter'
          description: Search by status
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: ShipmentSearchQuery
      type: object
      description: ShipmentSearchQuery
    ShipmentSearchQueryWrapper:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ShipmentSearchQuery'
          maxItems: 500
          type: array
        anonymized:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by anonymized
        carrierKey:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierKey
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by created
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/ShipmentSearchQuery'
          maxItems: 500
          type: array
        parcels:
          allOf:
            - $ref: '#/components/schemas/ShipmentParcelsListFilter'
          description: Nested list search by parcels
        pickJobRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by pickJobRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        status:
          allOf:
            - $ref: '#/components/schemas/ShipmentStatusEnumFilter'
          description: Search by status
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      required:
        - created
      title: ShipmentSearchQueryWrapper
      type: object
      description: ShipmentSearchQueryWrapper
    ShipmentSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
      title: ShipmentSort
      type: object
      description: ShipmentSort
    ShipmentSplitLineItemsActionEnum:
      enum:
        - SPLIT_LINE_LINES_SHIPMENT
      type: string
      title: ShipmentSplitLineItemsActionEnum
      description: ShipmentSplitLineItemsActionEnum
    ShipmentSplitLineItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ShipmentSplitLineItemsActionEnum'
        splitLineItemsInfo:
          items:
            $ref: '#/components/schemas/ShipmentSplitLineItemsInfo'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - splitLineItemsInfo
      title: ShipmentSplitLineItemsActionParameter
      type: object
      description: ShipmentSplitLineItemsActionParameter
    ShipmentSplitLineItemsInfo:
      additionalProperties: false
      properties:
        lineItemId:
          description: references the id of the item of a shipment
          type: string
        quantity:
          description: quantity of the specific item that has been shipped
          example: 21
          minimum: 1
          type: integer
      required:
        - lineItemId
        - quantity
      type: object
      title: ShipmentSplitLineItemsInfo
      description: ShipmentSplitLineItemsInfo
    ShipmentStatus:
      description: >-
        Every newly created shipment is in state INITIAL. When the parcel labels
        should be requested the state changes to REQUEST and as soon as all
        parcel labels are successfully requested the state changes to CONFIRMED.
        The state COMPLETED is set in the end or the process
      enum:
        - INITIAL
        - REQUEST
        - RETRYABLE
        - CONFIRMED
        - COMPLETED
        - CANCELED
        - OBSOLETE
      type: string
      title: ShipmentStatus
    ShipmentStatusEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - INITIAL
            - REQUEST
            - RETRYABLE
            - CONFIRMED
            - COMPLETED
            - CANCELED
            - OBSOLETE
          type: string
        in:
          description: Search by status
          items:
            enum:
              - INITIAL
              - REQUEST
              - RETRYABLE
              - CONFIRMED
              - COMPLETED
              - CANCELED
              - OBSOLETE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - INITIAL
            - REQUEST
            - RETRYABLE
            - CONFIRMED
            - COMPLETED
            - CANCELED
            - OBSOLETE
          type: string
      title: ShipmentStatusEnumFilter
      type: object
      description: ShipmentStatusEnumFilter
    ShipmentWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/Shipment'
      required:
        - payload
      type: object
      title: ShipmentWebHookEvent
      description: ShipmentWebHookEvent
    ShipmentWithSearchPath:
      allOf:
        - $ref: '#/components/schemas/Shipment'
        - additionalProperties: false
          properties:
            searchPaths:
              items:
                type: string
              minItems: 0
              type: array
          type: object
      title: ShipmentWithSearchPath
      description: ShipmentWithSearchPath
    ShippingConfiguration:
      properties:
        created:
          description: Creation date of this shippingConfiguration
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        id:
          description: Unique identifier of this shippingConfiguration
          example: 019f943c-687a-78cd-8d00-54323281eb27
          type: string
        lastModified:
          description: Last modification date of this shippingConfiguration
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        recommendationConfiguration:
          allOf:
            - $ref: '#/components/schemas/RecommendationConfiguration'
          description: Configuration for the automatic carrier recommendation for shipments
        version:
          description: Version number of this shippingConfiguration
          example: 1
          type: number
      required:
        - id
        - version
        - created
        - lastModified
      title: ShippingConfiguration
      type: object
      description: ShippingConfiguration
    ShippingConfigurationForUpdate:
      properties:
        recommendationConfiguration:
          allOf:
            - $ref: '#/components/schemas/RecommendationConfiguration'
          description: Configuration for the automatic carrier recommendation for shipments
        version:
          description: Version number of this shippingConfiguration
          example: 1
          type: number
      required:
        - version
      title: ShippingConfigurationForUpdate
      type: object
      description: ShippingConfigurationForUpdate
    ShippingCosts:
      additionalProperties: false
      properties:
        packageCosts:
          description: Costs of the individual packaging units
          items:
            $ref: '#/components/schemas/PackageCost'
          type: array
        totalTransportCostAmount:
          $ref: '#/components/schemas/Money'
          description: The total transport cost amount
      required:
        - totalTransportCostAmount
      type: object
      title: ShippingCosts
      description: ShippingCosts
    ShippingInformation:
      properties:
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        carrierRecipientInformation:
          description: >-
            Combination of address, carrier, carrier product and carrier service
            which can be referenced by line items. At the moment only address is
            implemented and only one carrierRecipientInformation is allowed.
          items:
            $ref: '#/components/schemas/CarrierRecipientInformation'
          maxItems: 1
          minItems: 1
          type: array
        created:
          description: Creation date of this shippingInformation
          example: 2025-08-04T08:16:07.000Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: Reference to related facility
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        id:
          description: Unique identifier of this shippingInformation
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        lastModified:
          description: Last modification date of this shippingInformation
          example: 2025-08-04T08:16:07.000Z
          format: date-time
          type: string
        operativeProcessRef:
          description: >-
            Reference to related operative process. If not passed, a new
            operative process will be created and the reference added.
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        processRef:
          description: >-
            Reference to related process. If not passed, a new process will be
            created and the reference added.
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        recommendedCarrier:
          allOf:
            - $ref: '#/components/schemas/RecommendedCarrier'
          description: Recommended carrier for this shippingInformation.
        senderAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Address of the sender for this shippingInformation
        shippingInformationLineItems:
          description: Items that are related to this shippingInformation
          items:
            $ref: '#/components/schemas/ShippingInformationLineItem'
          maxItems: 50
          minItems: 0
          type: array
        shortId:
          description: >-
            A short identifier that helps assigning a shippingInformation to a
            customer
          example: ABC123
          type: string
        status:
          description: The status of the shippingInformation
          example: AVAILABLE
          type: string
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: ORDER-12345
          type: string
        version:
          description: Version number of this shippingInformation
          example: 1
          type: number
      required:
        - id
        - version
        - created
        - lastModified
        - processRef
        - operativeProcessRef
        - facilityRef
        - status
        - carrierRecipientInformation
        - senderAddress
        - shippingInformationLineItems
      title: ShippingInformation
      type: object
      description: ShippingInformation
    ShippingInformationCarrierRecipientInformationAddressFilter:
      properties:
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by companyName
        email:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstName
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastName
      title: ShippingInformationCarrierRecipientInformationAddressFilter
      type: object
      description: ShippingInformationCarrierRecipientInformationAddressFilter
    ShippingInformationCarrierRecipientInformationAddressListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationCarrierRecipientInformationAddressFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ShippingInformationCarrierRecipientInformationAddressListFilter
      type: object
      description: ShippingInformationCarrierRecipientInformationAddressListFilter
    ShippingInformationCarrierRecipientInformationFilter:
      properties:
        address:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationCarrierRecipientInformationAddressListFilter
          description: Nested list search by address
      title: ShippingInformationCarrierRecipientInformationFilter
      type: object
      description: ShippingInformationCarrierRecipientInformationFilter
    ShippingInformationCarrierRecipientInformationListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationCarrierRecipientInformationFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ShippingInformationCarrierRecipientInformationListFilter
      type: object
      description: ShippingInformationCarrierRecipientInformationListFilter
    ShippingInformationForCreation:
      properties:
        anonymized:
          description: Indicates if gdpr related data was anonymized
          example: false
          type: boolean
        carrierRecipientInformation:
          description: >-
            Combination of address, carrier, carrier product and carrier service
            which can be referenced by line items. At the moment only address is
            implemented and only one carrierRecipientInformation is allowed.
          items:
            $ref: '#/components/schemas/CarrierRecipientInformationForCreation'
          maxItems: 1
          minItems: 1
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: Reference to related facility
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        operativeProcessRef:
          description: >-
            Reference to related operative process. If not passed, a new
            operative process will be created and the reference added.
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        processRef:
          description: >-
            Reference to related process. If not passed, a new process will be
            created and the reference added.
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        recommendedCarrier:
          allOf:
            - $ref: '#/components/schemas/RecommendedCarrier'
          description: Recommended carrier for this shippingInformation.
        senderAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Address of the sender for this shippingInformation
        shippingInformationLineItems:
          description: Items that are related to this shippingInformation
          items:
            $ref: '#/components/schemas/ShippingInformationLineItemForCreation'
          maxItems: 50
          minItems: 0
          type: array
        shortId:
          description: >-
            A short identifier that helps assigning a shippingInformation to a
            customer
          example: ABC123
          type: string
        status:
          description: The status of the shippingInformation
          example: AVAILABLE
          type: string
        tenantOrderId:
          description: >-
            Field can be used as a reference number in foreign systems, for
            example as a reference to the source system's identifier for this
            order.
          example: ORDER-12345
          type: string
      required:
        - facilityRef
        - senderAddress
        - shippingInformationLineItems
        - carrierRecipientInformation
      title: ShippingInformationForCreation
      type: object
      description: ShippingInformationForCreation
    ShippingInformationLineItem:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/LineItemArticle'
          description: Article information for this line item.
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities. If not passed, a new one will be
            generated.
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        id:
          description: Unique identifier of this shippingInformationLineItem
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        quantity:
          description: Quantity of this item
          example: 1
          minimum: 1
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the item that can be set during the
            process
          items:
            $ref: '#/components/schemas/RecordableAttribute'
          maxItems: 50
          minItems: 0
          type: array
        scannableCodes:
          description: Codes, that identify the article
          example:
            - ABC-12345
          items:
            type: string
          maxItems: 50
          minItems: 0
          type: array
      required:
        - id
        - article
        - quantity
      title: ShippingInformationLineItem
      type: object
      description: ShippingInformationLineItem
    ShippingInformationLineItemForCreation:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/LineItemArticle'
          description: Article information for this line item.
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities. If not passed, a new one will be
            generated.
          example: 019edfb7-f4cc-73ba-b117-8899ecbd1fa5
          type: string
        quantity:
          description: Quantity of this item
          example: 1
          minimum: 1
          type: number
        recordableAttributes:
          description: >-
            Customizable information about the item that can be set during the
            process
          items:
            $ref: '#/components/schemas/RecordableAttributeForCreation'
          maxItems: 50
          minItems: 0
          type: array
        scannableCodes:
          description: Codes, that identify the article
          example:
            - ABC-12345
          items:
            type: string
          maxItems: 50
          minItems: 0
          type: array
      required:
        - article
        - quantity
      title: ShippingInformationLineItemForCreation
      type: object
      description: ShippingInformationLineItemForCreation
    ShippingInformationPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        shippingInformationList:
          items:
            $ref: '#/components/schemas/ShippingInformation'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - shippingInformationList
      title: ShippingInformationPaginatedResult
      type: object
      description: ShippingInformationPaginatedResult
    ShippingInformationResponse:
      properties:
        shippingInformation:
          description: the shipping information entities found by the given search criteria
          items:
            $ref: '#/components/schemas/ShippingInformation'
          maxItems: 500
          type: array
        total:
          description: >-
            the total count of shipping information entities found by the given
            search criteria
          example: 42
          type: integer
      title: ShippingInformationResponse
      type: object
      description: ShippingInformationResponse
    ShippingInformationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ShippingInformationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ShippingInformationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ShippingInformationSearchPayload
      type: object
      description: ShippingInformationSearchPayload
    ShippingInformationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ShippingInformationSearchQuery'
          maxItems: 500
          type: array
        carrierRecipientInformation:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationCarrierRecipientInformationListFilter
          description: Nested list search by carrierRecipientInformation
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/ShippingInformationSearchQuery'
          maxItems: 500
          type: array
        shippingInformationLineItems:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationShippingInformationLineItemsListFilter
          description: Nested list search by shippingInformationLineItems
        shortId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shortId
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
      title: ShippingInformationSearchQuery
      type: object
      description: ShippingInformationSearchQuery
    ShippingInformationShippingInformationLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by title
      title: ShippingInformationShippingInformationLineItemsArticleFilter
      type: object
      description: ShippingInformationShippingInformationLineItemsArticleFilter
    ShippingInformationShippingInformationLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationShippingInformationLineItemsArticleFilter
          description: Nested search by article
      title: ShippingInformationShippingInformationLineItemsFilter
      type: object
      description: ShippingInformationShippingInformationLineItemsFilter
    ShippingInformationShippingInformationLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/ShippingInformationShippingInformationLineItemsFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: ShippingInformationShippingInformationLineItemsListFilter
      type: object
      description: ShippingInformationShippingInformationLineItemsListFilter
    ShippingInformationSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: ShippingInformationSort
      type: object
      description: ShippingInformationSort
    ShippingInformationWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ShippingInformation'
      required:
        - payload
      type: object
      title: ShippingInformationWebHookEvent
      description: ShippingInformationWebHookEvent
    ShortPickReason:
      additionalProperties: false
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
        active:
          description: Flag to mark a reason as active or inactive
          example: true
          type: boolean
        reason:
          description: translated reasonLocalized according to the given locale
          type: string
      required:
        - active
        - reasonLocalized
      title: ShortPickReason
      description: ShortPickReason
    ShortPickReasonForUpsert:
      additionalProperties: false
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
      type: object
      title: ShortPickReasonForUpsert
      description: ShortPickReasonForUpsert
    SimulationOrder:
      properties:
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
          description: Consumer information for the order
        created:
          description: Timestamp when the simulation order was created
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        customAttributes:
          description: Attributes that can be added to the order
          type: object
        customServices:
          description: Custom services for the order
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          maxItems: 100
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
          description: Delivery preferences for the order
        id:
          description: Unique identifier of the simulation order
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Timestamp when the simulation order was last modified
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        orderDate:
          description: The date this order was created at the supplying system
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        orderLineItems:
          description: Line items in the order
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          maxItems: 100
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
          description: Payment information for the order
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
          description: Promise options for the order
        status:
          description: Status of the order
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
        statusReasons:
          description: Status reasons for the order
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          maxItems: 100
          type: array
        stickers:
          description: Stickers associated with the order
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          type: array
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        version:
          description: Version number for optimistic locking
          example: 1
          type: number
        tags:
          description: Tags associated with the order
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 100
          type: array
      required:
        - consumer
        - orderDate
        - orderLineItems
        - id
        - version
        - created
        - lastModified
      title: SimulationOrder
      type: object
      description: SimulationOrder
    SimulationOrderConsumerAddressesAddressTypeEnumFilter:
      properties:
        eq:
          description: Search by addressType
          enum:
            - POSTAL_ADDRESS
            - PARCEL_LOCKER
            - INVOICE_ADDRESS
          type: string
        in:
          description: Search by addressType
          items:
            enum:
              - POSTAL_ADDRESS
              - PARCEL_LOCKER
              - INVOICE_ADDRESS
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by addressType
          enum:
            - POSTAL_ADDRESS
            - PARCEL_LOCKER
            - INVOICE_ADDRESS
          type: string
      title: SimulationOrderConsumerAddressesAddressTypeEnumFilter
      type: object
      description: SimulationOrderConsumerAddressesAddressTypeEnumFilter
    SimulationOrderConsumerAddressesFilter:
      properties:
        addressType:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderConsumerAddressesAddressTypeEnumFilter
          description: Search by addressType
        city:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by city
          example: Yellowstone
        companyName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by companyName
        country:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by country
          example: US
        email:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by email
          example: phil.bison@fulfillmenttools.com
        firstName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by firstName
        houseNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by houseNumber
          example: 42
        lastName:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by lastName
        postalCode:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by postalCode
          example: '42420'
        province:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by province
        street:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by street
      title: SimulationOrderConsumerAddressesFilter
      type: object
      description: SimulationOrderConsumerAddressesFilter
    SimulationOrderConsumerAddressesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderConsumerAddressesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: SimulationOrderConsumerAddressesListFilter
      type: object
      description: SimulationOrderConsumerAddressesListFilter
    SimulationOrderConsumerFilter:
      properties:
        addresses:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderConsumerAddressesListFilter'
          description: Nested list search by addresses
        consumerId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by consumerId
      title: SimulationOrderConsumerFilter
      type: object
      description: SimulationOrderConsumerFilter
    SimulationOrderDeliveryPreferencesCollectFilter:
      properties:
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        paid:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by paid
      title: SimulationOrderDeliveryPreferencesCollectFilter
      type: object
      description: SimulationOrderDeliveryPreferencesCollectFilter
    SimulationOrderDeliveryPreferencesCollectListFilter:
      properties:
        contains:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderDeliveryPreferencesCollectFilter
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: SimulationOrderDeliveryPreferencesCollectListFilter
      type: object
      description: SimulationOrderDeliveryPreferencesCollectListFilter
    SimulationOrderDeliveryPreferencesFilter:
      properties:
        collect:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderDeliveryPreferencesCollectListFilter
          description: Nested list search by collect
        shipping:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderDeliveryPreferencesShippingFilter
          description: Nested search by shipping
      title: SimulationOrderDeliveryPreferencesFilter
      type: object
      description: SimulationOrderDeliveryPreferencesFilter
    SimulationOrderDeliveryPreferencesShippingFilter:
      properties:
        desiredDeliveryTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by desiredDeliveryTime
          example: 2026-06-17T12:00:00.000Z
        serviceLevel:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter
          description: Search by serviceLevel
      title: SimulationOrderDeliveryPreferencesShippingFilter
      type: object
      description: SimulationOrderDeliveryPreferencesShippingFilter
    SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter:
      properties:
        eq:
          description: Search by serviceLevel
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
        in:
          description: Search by serviceLevel
          items:
            enum:
              - DELIVERY
              - SAMEDAY
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by serviceLevel
          enum:
            - DELIVERY
            - SAMEDAY
          type: string
      title: SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter
      type: object
      description: SimulationOrderDeliveryPreferencesShippingServiceLevelEnumFilter
    SimulationOrderForCreation:
      properties:
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
          description: Consumer information for the order
        customAttributes:
          description: Attributes that can be added to the order
          type: object
        customServices:
          description: Custom services for the order
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          maxItems: 100
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
          description: Delivery preferences for the order
        orderDate:
          description: The date this order was created at the supplying system
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        orderLineItems:
          description: Line items in the order
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          maxItems: 100
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
          description: Payment information for the order
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
          description: Promise options for the order
        status:
          description: Status of the order
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
        statusReasons:
          description: Status reasons for the order
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          maxItems: 100
          type: array
        stickers:
          description: Stickers associated with the order
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          type: array
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        tags:
          description: Tags associated with the order
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 100
          type: array
      required:
        - consumer
        - orderDate
        - orderLineItems
      title: SimulationOrderForCreation
      type: object
      description: SimulationOrderForCreation
    SimulationOrderForPartialUpdate:
      properties:
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
          description: Consumer information for the order
        customAttributes:
          description: Attributes that can be added to the order
          type: object
        customServices:
          description: Custom services for the order
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          maxItems: 100
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
          description: Delivery preferences for the order
        orderDate:
          description: The date this order was created at the supplying system
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        orderLineItems:
          description: Line items in the order
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          maxItems: 100
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
          description: Payment information for the order
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
          description: Promise options for the order
        status:
          description: Status of the order
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
        statusReasons:
          description: Status reasons for the order
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          maxItems: 100
          type: array
        stickers:
          description: Stickers associated with the order
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          type: array
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        version:
          description: Version number for optimistic locking
          example: 1
          type: number
        tags:
          description: Tags associated with the order
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 100
          type: array
      required:
        - version
      title: SimulationOrderForPartialUpdate
      type: object
      description: SimulationOrderForPartialUpdate
    SimulationOrderForUpdate:
      properties:
        consumer:
          $ref: '#/components/schemas/OrderForCreationConsumer'
          description: Consumer information for the order
        customAttributes:
          description: Attributes that can be added to the order
          type: object
        customServices:
          description: Custom services for the order
          items:
            $ref: '#/components/schemas/CustomServiceReferenceForCreation'
          maxItems: 100
          type: array
        deliveryPreferences:
          $ref: '#/components/schemas/DeliveryPreferences'
          description: Delivery preferences for the order
        orderDate:
          description: The date this order was created at the supplying system
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        orderLineItems:
          description: Line items in the order
          items:
            $ref: '#/components/schemas/OrderLineItemForCreation'
          maxItems: 100
          type: array
        paymentInfo:
          $ref: '#/components/schemas/OrderPaymentInfoForCreation'
          description: Payment information for the order
        promisesOptions:
          $ref: '#/components/schemas/OrderPromisesOptions'
          description: Promise options for the order
        status:
          description: Status of the order
          enum:
            - OPEN
            - CANCELLED
            - PROMISED
            - LOCKED
            - OBSOLETE
          type: string
        statusReasons:
          description: Status reasons for the order
          items:
            $ref: '#/components/schemas/OrderStatusReason'
          maxItems: 100
          type: array
        stickers:
          description: Stickers associated with the order
          items:
            $ref: '#/components/schemas/Sticker'
          maxItems: 100
          type: array
        tenantOrderId:
          description: Tenant-specific order identifier
          example: MY_ORDER_ID
          type: string
        version:
          description: Version number for optimistic locking
          example: 1
          type: number
        tags:
          description: Tags associated with the order
          items:
            $ref: '#/components/schemas/TagReference'
          maxItems: 100
          type: array
      required:
        - consumer
        - orderDate
        - orderLineItems
        - version
      title: SimulationOrderForUpdate
      type: object
      description: SimulationOrderForUpdate
    SimulationOrderOrderLineItemsArticleFilter:
      properties:
        titleLocalized:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderOrderLineItemsArticleTitleLocalizedFilter
          description: Nested search by titleLocalized
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        title:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by title
      title: SimulationOrderOrderLineItemsArticleFilter
      type: object
      description: SimulationOrderOrderLineItemsArticleFilter
    SimulationOrderOrderLineItemsArticleTitleLocalizedFilter:
      properties:
        de_DE:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by de_DE
        en_US:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by en_US
        ru_RU:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by ru_RU
      title: SimulationOrderOrderLineItemsArticleTitleLocalizedFilter
      type: object
      description: SimulationOrderOrderLineItemsArticleTitleLocalizedFilter
    SimulationOrderOrderLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderOrderLineItemsArticleFilter'
          description: Nested search by article
      title: SimulationOrderOrderLineItemsFilter
      type: object
      description: SimulationOrderOrderLineItemsFilter
    SimulationOrderOrderLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderOrderLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: SimulationOrderOrderLineItemsListFilter
      type: object
      description: SimulationOrderOrderLineItemsListFilter
    SimulationOrderPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        simulationOrders:
          items:
            $ref: '#/components/schemas/SimulationOrder'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - simulationOrders
      title: SimulationOrderPaginatedResult
      type: object
      description: SimulationOrderPaginatedResult
    SimulationOrderPaymentInfoFilter:
      properties:
        methodLocalized:
          allOf:
            - $ref: >-
                #/components/schemas/SimulationOrderPaymentInfoMethodLocalizedFilter
          description: Nested search by methodLocalized
        currency:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by currency
        method:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by method
      title: SimulationOrderPaymentInfoFilter
      type: object
      description: SimulationOrderPaymentInfoFilter
    SimulationOrderPaymentInfoMethodLocalizedFilter:
      properties:
        de_DE:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by de_DE
        en_US:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by en_US
        ru_RU:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by ru_RU
      title: SimulationOrderPaymentInfoMethodLocalizedFilter
      type: object
      description: SimulationOrderPaymentInfoMethodLocalizedFilter
    SimulationOrderSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/SimulationOrderSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/SimulationOrderSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: SimulationOrderSearchPayload
      type: object
      description: SimulationOrderSearchPayload
    SimulationOrderSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/SimulationOrderSearchQuery'
          maxItems: 500
          type: array
        consumer:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderConsumerFilter'
          description: Nested search by consumer
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        deliveryPreferences:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderDeliveryPreferencesFilter'
          description: Nested search by deliveryPreferences
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/SimulationOrderSearchQuery'
          maxItems: 500
          type: array
        orderDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by orderDate. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
          example: 2026-06-17T12:00:00.000Z
        orderLineItems:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderOrderLineItemsListFilter'
          description: Nested list search by orderLineItems
        paymentInfo:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderPaymentInfoFilter'
          description: Nested search by paymentInfo
        tenantOrderId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantOrderId
          example: MY_ORDER_ID
        tags:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderTagsListFilter'
          description: Nested list search by tags
      title: SimulationOrderSearchQuery
      type: object
      description: SimulationOrderSearchQuery
    SimulationOrderSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        orderDate:
          enum:
            - ASC
            - DESC
          type: string
      title: SimulationOrderSort
      type: object
      description: SimulationOrderSort
    SimulationOrderTagsFilter:
      properties:
        value:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by value
      title: SimulationOrderTagsFilter
      type: object
      description: SimulationOrderTagsFilter
    SimulationOrderTagsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/SimulationOrderTagsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: SimulationOrderTagsListFilter
      type: object
      description: SimulationOrderTagsListFilter
    SortDirection:
      enum:
        - ASCENDING
        - DESCENDING
      type: string
      title: SortDirection
      description: SortDirection
    SortParameter:
      properties:
        sortDirection:
          $ref: '#/components/schemas/SortDirection'
        sortParameterName:
          $ref: '#/components/schemas/SortParameterName'
      required:
        - sortDirection
        - sortParameterName
      type: object
      title: SortParameter
      description: SortParameter
    SortParameterName:
      enum:
        - NAME
        - ADDRESS
        - STATUS
        - OPERATIVESTATUS
        - SERVICETYPE
        - ORDEREDAMOUNT
        - ORDERDATE
        - ORDERID
      type: string
      title: SortParameterName
      description: SortParameterName
    SourceRef:
      additionalProperties: false
      properties:
        sourceRef:
          type: string
      required:
        - sourceRef
      type: object
      title: SourceRef
      description: SourceRef
    SourcingOption:
      properties:
        estimatedDeliveryDate:
          description: Estimated delivery date in format YYYY-MM-DD.
          example: 2025-02-05T00:00:00.000Z
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
        estimatedPickupDate:
          description: Estimated pickup date in format YYYY-MM-DD.
          example: 2025-02-05T00:00:00.000Z
          format: date
          pattern: ^\d{4}-\d{2}-\d{2}$
          type: string
        id:
          type: string
        listingDetails:
          items:
            $ref: '#/components/schemas/SourcingOptionListingDetails'
          type: array
        nodes:
          items:
            $ref: '#/components/schemas/SourcingOptionNode'
          type: array
        nonAssignedOrderLineItems:
          items:
            $ref: '#/components/schemas/HandledItem'
          type: array
        priorityRatingResults:
          items:
            $ref: '#/components/schemas/PriorityRatingResult'
          type: array
        ratingResults:
          items:
            $ref: '#/components/schemas/RatingResult'
          type: array
        runId:
          type: string
        totalCosts:
          $ref: '#/components/schemas/SourcingOptionCosts'
        totalPenalty:
          description: The total calculated penalty we calculated for this option
          example: 187
          type: number
        transfers:
          items:
            $ref: '#/components/schemas/SourcingOptionTransfer'
          type: array
        validUntil:
          description: >-
            The latest date at which this option is still valid in UTC (ISO8601
            format).
          type: string
      required:
        - id
        - runId
        - totalPenalty
        - nodes
        - transfers
        - ratingResults
        - priorityRatingResults
      type: object
      title: SourcingOption
      description: SourcingOption
    SourcingOptionAnalyzeActionFacilityResult:
      properties:
        analyzedConnections:
          allOf:
            - $ref: '#/components/schemas/ConnectionsAnalysisResult'
          description: >-
            Analysis of connections. Null when the facility is inside the
            resulting graph.
        fenceAnalysis:
          description: List of fence analyses.
          items:
            $ref: '#/components/schemas/FenceAnalysis'
          type: array
        listingAvailability:
          description: List of listing availability analyses.
          items:
            $ref: '#/components/schemas/ListingAvailabilityAnalysis'
          type: array
        lookupFacilityId:
          description: The ID of the facility being looked up.
          type: string
      required:
        - lookupFacilityId
        - listingAvailability
        - fenceAnalysis
      title: SourcingOptionAnalyzeActionFacilityResult
      type: object
      description: SourcingOptionAnalyzeActionFacilityResult
    SourcingOptionAnalyzeActionResult:
      properties:
        evaluationTimestamp:
          description: The timestamp when the evaluation was performed.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        orderId:
          description: The ID of the order.
          type: string
        reasons:
          description: List of facility-level analysis results.
          items:
            $ref: '#/components/schemas/SourcingOptionAnalyzeActionFacilityResult'
          type: array
        runId:
          description: The runId of the sourcingOption analyses.
          type: string
      required:
        - orderId
        - evaluationTimestamp
        - runId
        - reasons
      title: SourcingOptionAnalyzeActionResult
      type: object
      description: SourcingOptionAnalyzeActionResult
    SourcingOptionAnalyzeParameter:
      properties:
        createdTime:
          description: >-
            The creation time of the order for which the sourcing option
            analysis is performed.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        facilityIds:
          description: The list of facility IDs that receive a detailed analysis.
          items:
            type: string
          type: array
        orderId:
          description: >-
            The ID of the order for which the sourcing option analysis is
            performed.
          type: string
        runId:
          description: The run ID of the sourcing option request.
          type: string
        sourcingOptionId:
          description: The ID of the sourcing option to analyze.
          type: string
      required:
        - facilityIds
      title: SourcingOptionAnalyzeParameter
      type: object
      description: SourcingOptionAnalyzeParameter
    SourcingOptionCosts:
      additionalProperties: false
      properties:
        salesPrices:
          description: >-
            Sales prices and applied discounts of the individual items in the
            solution. Only present if costComponentRating is enabled.
          items:
            $ref: '#/components/schemas/SourcingOptionSalesPrice'
          type: array
        totalCosts:
          $ref: '#/components/schemas/Money'
        totalSalesPriceAmount:
          $ref: '#/components/schemas/Money'
        totalShippingCosts:
          $ref: '#/components/schemas/ShippingCosts'
      required:
        - salesPrices
      type: object
      title: SourcingOptionCosts
      description: SourcingOptionCosts
    SourcingOptionListingDetails:
      properties:
        customAttributes:
          additionalProperties: true
          type: object
        facilityRef:
          example: abcd-efgh-ijkl-mnop
          type: string
        tenantArticleId:
          example: CGN-4711
          type: string
      title: SourcingOptionListingDetails
      description: SourcingOptionListingDetails
    SourcingOptionNode:
      properties:
        facilityRef:
          example: DE-FAC-4711
          type: string
        id:
          description: id of this node, unique for this Sourcing Option Responses
          example: f439e7b6-119e-47cc-a263-05a31baea0de
          type: string
        isPickUpLocation:
          description: Indicates if this node is a pick up location
          type: boolean
        lineItems:
          items:
            $ref: '#/components/schemas/HandledItem'
          type: array
        tenantFacilityId:
          example: DE-FAC-4711
          type: string
        type:
          $ref: '#/components/schemas/NodeType'
      required:
        - id
        - type
        - lineItems
      type: object
      title: SourcingOptionNode
      description: SourcingOptionNode
    SourcingOptionSalesPrice:
      additionalProperties: false
      properties:
        amount:
          description: The amount of the item in the solution
          example: 1
          type: number
        discount:
          items:
            oneOf:
              - $ref: '#/components/schemas/FacilityDiscountRelative'
              - $ref: '#/components/schemas/FacilityDiscountAbsoluteForCreation'
          type: array
        salesPricePerUnitWithDiscountAmount:
          $ref: '#/components/schemas/Money'
          description: The sales price per unit with discount
        salesPricePerUnitWithoutDiscountAmount:
          $ref: '#/components/schemas/Money'
          description: The sales price per unit without discount
        sourceFacilityRef:
          description: The facility reference of the source facility
          example: DE-FAC-4711
          type: string
        sourceTenantFacilityId:
          description: The tenant facility id of the source facility
          example: facility-east
          type: string
        tenantArticleId:
          description: The tenant article id of the item
          example: DE-ZGT-4711
          type: string
      required:
        - tenantArticleId
        - salesPricePerUnitWithoutDiscountAmount
        - amount
        - sourceFacilityRef
      type: object
      title: SourcingOptionSalesPrice
      description: SourcingOptionSalesPrice
    SourcingOptionsExecutionResults:
      properties:
        totalRatingResults:
          items:
            $ref: '#/components/schemas/SourcingOptionTotalRatingResult'
          type: array
      type: object
      title: SourcingOptionsExecutionResults
      description: SourcingOptionsExecutionResults
    SourcingOptionsRequest:
      properties:
        additionalInfo:
          $ref: '#/components/schemas/SourcingOptionsRequestAdditionalInfo'
        optimizationHints:
          $ref: '#/components/schemas/OptimizationHints'
        order:
          $ref: '#/components/schemas/OrderForSourcingOptionsRequest'
        resourceInvestment:
          $ref: '#/components/schemas/ResourceInvestment'
      required:
        - order
      type: object
      title: SourcingOptionsRequest
      description: SourcingOptionsRequest
    SourcingOptionsRequestAdditionalInfo:
      properties:
        includeListingCustomAttributes:
          default: false
          description: >-
            If true, the listing custom attributes are included in the response.
            This is useful for debugging purposes.
          type: boolean
      type: object
      title: SourcingOptionsRequestAdditionalInfo
      description: SourcingOptionsRequestAdditionalInfo
    SourcingOptionsResponse:
      properties:
        id:
          description: Id referring optimizations runId
          example: 284f32cc-b106-487d-b633-f90d93d8c251
          type: string
        result:
          $ref: '#/components/schemas/SourcingOptionsResult'
      required:
        - id
        - result
      type: object
      title: SourcingOptionsResponse
      description: SourcingOptionsResponse
    SourcingOptionsResult:
      properties:
        options:
          items:
            $ref: '#/components/schemas/SourcingOption'
          type: array
      required:
        - options
      type: object
      title: SourcingOptionsResult
      description: SourcingOptionsResult
    SourcingOptionsTransferDeliverCostCoefficient:
      properties:
        measurementUnit:
          $ref: '#/components/schemas/CostCoefficientMeasurementUnit'
        value:
          type: number
      required:
        - value
        - measurementUnit
      type: object
      title: SourcingOptionsTransferDeliverCostCoefficient
      description: SourcingOptionsTransferDeliverCostCoefficient
    SourcingOptionsTransferDeliveryCost:
      allOf:
        - $ref: '#/components/schemas/Money'
      properties:
        deliveryCostCoefficient:
          $ref: '#/components/schemas/SourcingOptionsTransferDeliverCostCoefficient'
      type: object
      xml:
        name: SourcingOptionsTransferDeliveryCost
      title: SourcingOptionsTransferDeliveryCost
      description: SourcingOptionsTransferDeliveryCost
    SourcingOptionsTransferPackagingInformation:
      properties:
        packagingUnit:
          $ref: '#/components/schemas/SourcingOptionsTransferPackagingUnit'
        packedItems:
          items:
            $ref: '#/components/schemas/HandledItem'
          type: array
        totalCosts:
          $ref: '#/components/schemas/Money'
          description: Total costs for this packaging information
      required:
        - packagingUnit
        - totalCosts
        - packedItems
      type: object
      title: SourcingOptionsTransferPackagingInformation
      description: SourcingOptionsTransferPackagingInformation
    SourcingOptionsTransferPackagingUnit:
      properties:
        dimensions:
          $ref: '#/components/schemas/SourcingOptionsTransferPackagingUnitDimensions'
        maxItemQuantity:
          description: >-
            The maximum number of items that can be packed in this packaging
            unit
          example: 10
          type: integer
        name:
          example: Small Box
          type: string
        packagingUnitRef:
          type: string
        prices:
          items:
            $ref: '#/components/schemas/SourcingOptionsTransferDeliveryCost'
          type: array
        priority:
          description: The priority of this packaging unit, lower values are preferred
          example: 1
          type: integer
        tenantPackagingUnitId:
          type: string
        transitTime:
          $ref: '#/components/schemas/SourcingOptionsTransferTransitTime'
        volumeBufferInPercent:
          description: The volume buffer in percent for this packaging unit
          example: 10
          type: number
      required:
        - name
        - priority
      type: object
      title: SourcingOptionsTransferPackagingUnit
      description: SourcingOptionsTransferPackagingUnit
    SourcingOptionsTransferPackagingUnitDimensions:
      properties:
        height:
          type: number
        length:
          type: number
        maxWeightInGram:
          type: number
        width:
          type: number
      type: object
      title: SourcingOptionsTransferPackagingUnitDimensions
      description: SourcingOptionsTransferPackagingUnitDimensions
    SourcingOptionsTransferTransitTime:
      properties:
        maxTransitDays:
          type: number
        minTransitDays:
          type: number
      required:
        - minTransitDays
        - maxTransitDays
      type: object
      title: SourcingOptionsTransferTransitTime
      description: SourcingOptionsTransferTransitTime
    SourcingOptionTotalRatingResult:
      properties:
        avgPenalty:
          type: number
        id:
          type: string
        maxPenalty:
          type: number
        minPenalty:
          type: number
      required:
        - id
        - minPenalty
        - maxPenalty
        - avgPenalty
      type: object
      title: SourcingOptionTotalRatingResult
      description: SourcingOptionTotalRatingResult
    SourcingOptionTransfer:
      properties:
        carrier:
          properties:
            carrierKey:
              type: string
            carrierName:
              type: string
          type: object
        existenceReason:
          $ref: '#/components/schemas/SourcingOptionTransferExistenceReason'
        facilityConnectionRef:
          example: f439e7b6-119e-47cc-a263-05a31baea0de
          type: string
        fallbackCosts:
          $ref: '#/components/schemas/Money'
        lineItems:
          items:
            $ref: '#/components/schemas/HandledItem'
          type: array
        packagingInformation:
          items:
            $ref: '#/components/schemas/SourcingOptionsTransferPackagingInformation'
          type: array
        sourceNodeRef:
          example: f439e7b6-119e-47cc-a263-05a31baea0de
          type: string
        strandId:
          example: f439e7b6-119e-47cc-a263-05a31baea0de
          type: string
        targetNodeRef:
          example: ad6c5038-15ee-41b8-a180-4c86290d04c3
          type: string
        timeLine:
          $ref: '#/components/schemas/TransferTimeLine'
        transferGroup:
          description: >-
            The transferGroup identifying transfers that travel together in the
            same delivery time window. Transfers with the same transferGroup are
            expected to be fulfilled within the same temporal delivery slot.
          example: 0_xyz
          type: string
      required:
        - sourceNodeRef
        - targetNodeRef
        - lineItems
        - packagingInformation
      type: object
      title: SourcingOptionTransfer
      description: SourcingOptionTransfer
    SourcingOptionTransferExistenceReason:
      enum:
        - KEPT_FROM_LAST_RUN
      type: string
      title: SourcingOptionTransferExistenceReason
      description: SourcingOptionTransferExistenceReason
    SplitInformation:
      properties:
        splitCount:
          type: number
        splittedItems:
          items:
            $ref: '#/components/schemas/AssignmentItem'
          type: array
        targetFacility:
          $ref: '#/components/schemas/DecisionLogFacilityInfo'
        targetRoutingPlanRef:
          type: string
      required:
        - splitCount
        - targetRoutingPlanRef
        - splittedItems
      title: SplitInformation
      description: SplitInformation
    SplitResultType:
      enum:
        - SPLIT
        - DO_NOT_SPLIT
        - DO_NOT_SPLIT_USE_BEST_RATED
        - DO_NOT_SPLIT_BECAUSE_AVAILABILITY_USE_BEST_RATED
        - DO_NOT_SPLIT_USE_BEST_AVAILABLE
        - REASSIGN_TO_PARENT
        - REASSIGN_TO_PARENT_COMPLETELY
        - FAIL
        - INVALID_SPLIT
        - PARK_IN_WAITING_ROOM
      title: SplitResultType
      description: SplitResultType
    Stack:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        facilityRefs:
          description: Linked Facilities through reference
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
        id:
          description: Unique identifier of the Stack
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        processRefs:
          description: Linked Processes through reference
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - created
        - lastModified
        - version
        - id
        - facilityRefs
        - processRefs
      title: Stack
      type: object
      description: Stack
    StackForCreation:
      properties:
        facilityRefs:
          description: Linked Facilities through reference
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
        processRefs:
          description: Linked Processes through reference
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 50
          type: array
      required:
        - facilityRefs
        - processRefs
      title: StackForCreation
      type: object
      description: StackForCreation
    StackResponse:
      properties:
        stacks:
          description: Array of Stacks matching the given filter
          items:
            $ref: '#/components/schemas/Stack'
          type: array
        total:
          description: Total number of stacks for the given filter
          example: 42
          format: int64
          type: integer
      required:
        - stacks
        - total
      title: StackResponse
      type: object
      description: StackResponse
    StartItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - StartItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: StartItemReturnActionParameter
      type: object
      description: StartItemReturnActionParameter
    StartItemReturnJobActionParameter:
      properties:
        name:
          enum:
            - StartItemReturnJob
          type: string
        version:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
      required:
        - version
        - name
      title: StartItemReturnJobActionParameter
      type: object
      description: StartItemReturnJobActionParameter
    StartPickRun:
      allOf:
        - additionalProperties: false
          properties:
            action:
              description: Use value 'StartPickRun', because you want to start a pickrun
              enum:
                - StartPickRun
              type: string
          required:
            - action
          type: object
      deprecated: true
      description: >-
        This part of the API is deprecated. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />@deprecated Use api/pickruns/:id/actions instead
      title: StartPickRun
      xml:
        name: StartPickRun
    StartStowJobAction:
      description: Sets the status of the stowjob to IN_PROGRESS
      properties:
        name:
          description: The name of the action that should be performed
          enum:
            - START_STOW_JOB
          type: string
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
      title: StartStowJobAction
      type: object
    Status:
      additionalProperties: false
      properties:
        status:
          description: The current state of the API
          enum:
            - UP
            - DEGRADED
            - DOWN
          type: string
      required:
        - status
      type: object
      xml:
        name: Status
      title: Status
      description: Status
    StatusReason:
      properties:
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        reason:
          description: translated reason selected from reasonLocalized
          example: Broken Item
          minLength: 1
          type: string
      required:
        - reasonLocalized
      title: StatusReason
      type: object
      description: StatusReason
    StatusReasonsPayload:
      properties:
        statusReason:
          allOf:
            - $ref: '#/components/schemas/OrderStatusReasonLog'
          description: Reason for the status change
          type: object
      type: object
      title: StatusReasonsPayload
      description: StatusReasonsPayload
    Sticker:
      additionalProperties: false
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/LocaleString'
          description: >-
            Dictionary of possible translations, min 1 entry, max 14 characters
            per description
          example: '{ en_US: ''SomeName'' }'
        color:
          description: optional color coding for the sticker
          example: '#19b6b5'
          type: string
        key:
          description: unique identifier
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        name:
          description: Translated display name
          example: SomeName
          type: string
        priority:
          description: priority of the given sticker
          example: 100
          format: int64
          maximum: 10000
          minimum: 1
          type: integer
      required:
        - key
        - nameLocalized
        - priority
      title: Sticker
      description: Sticker
    StickerConfiguration:
      additionalProperties: false
      properties:
        offeredStickersByTag:
          items:
            $ref: '#/components/schemas/OfferedStickersByTag'
          maxItems: 500
          type: array
      title: StickerConfiguration
      description: StickerConfiguration
    Stock:
      properties:
        available:
          type: number
        availableUntil:
          description: >-
            defines until when a stock is included in the stock availability as
            available and used for routing
          format: date-time
          type: string
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facility:
          $ref: '#/components/schemas/StockFacilityReferences'
        facilityRef:
          description: facility in which the stock is located
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        facilityWideReserved:
          deprecated: true
          type: number
        id:
          type: string
        lastModified:
          format: date-time
          type: string
        locationRef:
          description: location on which the stock is placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        properties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
          description: >-
            allow tracking of specific values such as expiry dates on a set of
            items. They should describe physical identifiable properties of the
            stock and are not meant to be used for metadata (see
            "customAttributes" for that).
        receiptDate:
          description: >-
            date-time when stock has entered the system, defaults to the
            creation date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        reserved:
          description: amount of this stock reserved for customer orders
          type: number
        scannableCodes:
          description: scannableCodes such as barcodes that identify this stock
          items:
            type: string
          type: array
        scores:
          description: >-
            stock with a high score can used preferably over stock with a lower
            score in routing, depending on configuration. The score can
            represent different attributes of the stock like zone, storage
            location, expiry date or receipt date.
          items:
            $ref: '#/components/schemas/Score'
          type: array
        serializedProperties:
          description: >-
            properties object serialized as JSON string, sorted alphabetically
            by key
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock
          example: MY_ARTICLE_ID
          minLength: 1
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        traits:
          description: >-
            provide information on how storage locations and stocks are to be
            handled in operational processes. Can only be set via
            storageLocation. 
          items:
            enum:
              - PICKABLE
              - ACCESSIBLE
              - KEEP_ON_ZERO
              - OUTBOUND
              - IN_MOTION
            type: string
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
        version:
          type: number
      required:
        - tenantArticleId
        - value
        - reserved
        - facilityWideReserved
        - facilityRef
        - facility
        - available
        - id
        - version
        - created
        - lastModified
        - traits
        - serializedProperties
      title: Stock
      type: object
      description: Stock
    StockAction:
      properties:
        action:
          description: >-
            Action to be performed on the stock. If a user has specific facility
            context limitations, only stocks located in the referenced
            facilities will be affected
          discriminator:
            propertyName: name
          oneOf:
            - $ref: '#/components/schemas/StockDeleteByLocations'
            - $ref: '#/components/schemas/StockDeleteByProducts'
            - $ref: '#/components/schemas/StockDeleteByIds'
            - $ref: '#/components/schemas/StockMoveToLocation'
            - $ref: '#/components/schemas/VersionlessUpdateStock'
        actions:
          deprecated: true
          description: Deprecated. Use 'action' with a single action input instead.
          items:
            oneOf:
              - $ref: '#/components/schemas/StockDeleteByLocations'
              - $ref: '#/components/schemas/StockDeleteByProducts'
              - $ref: '#/components/schemas/StockDeleteByIds'
          maxItems: 10
          type: array
      title: StockAction
      type: object
      description: StockAction
    StockActionResult:
      properties:
        name:
          enum:
            - DELETE_BY_LOCATIONS
            - DELETE_BY_PRODUCTS
            - DELETE_BY_IDS
            - MOVE_TO_LOCATION
            - UPDATE_VERSIONLESS
          type: string
        result:
          oneOf:
            - $ref: '#/components/schemas/StockDeleteActionResult'
            - $ref: '#/components/schemas/StockMoveToLocationActionResult'
            - $ref: '#/components/schemas/StockVersionlessUpsertActionResult'
      required:
        - name
        - result
      title: StockActionResult
      type: object
      description: StockActionResult
    StockConditionEnumFilter:
      properties:
        eq:
          description: Search by conditions
          enum:
            - DEFECTIVE
          type: string
        in:
          description: Search by conditions
          items:
            enum:
              - DEFECTIVE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by conditions
          enum:
            - DEFECTIVE
          type: string
      title: StockConditionEnumFilter
      type: object
      description: StockConditionEnumFilter
    StockConditionEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/StockConditionEnumFilter'
          description: Search by conditions
      title: StockConditionEnumListFilter
      type: object
      description: StockConditionEnumListFilter
    StockConfiguration:
      allOf:
        - $ref: '#/components/schemas/StockConfigurationForUpdate'
        - $ref: '#/components/schemas/VersionedResource'
      description: >-
        https://docs.fulfillmenttools.com/documentation/products/inventory-management/configurations
      properties:
        id:
          type: string
      type: object
      xml:
        name: StockConfiguration
      title: StockConfiguration
    StockConfigurationForCreation:
      description: Stock configuration data for creation
      properties:
        expectedStock:
          description: >-
            This part of the API is in Beta status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Configuration for expected stock generation from routing plans
          properties:
            generateFromRoutingPlan:
              default: false
              description: >-
                If true, automatically create incoming expected stock after
                routing
              example: false
              type: boolean
          type: object
          x-badges:
            - color: orange
              label: BETA
        inboundProcess:
          description: >-
            This part of the API is in Beta status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Configuration for inbound process creation from interfacility
            transfers
          properties:
            generateFromInterfacilityTransfer:
              default: true
              description: >-
                If true, automatically create an internal purchase order when an
                interfacility transfer is handed over. Defaults to true.
              example: true
              type: boolean
          type: object
          x-badges:
            - color: orange
              label: BETA
        reservedStock:
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />This config has no effect yet
          properties:
            clearAllPredecessors:
              deprecated: true
              description: >-
                @deprecated Clear stocks and reservations in supplying
                facilities when handover events occur in the receiving facility
              type: boolean
            clearStocksAndReservationsTrigger:
              description: >-
                Clear related stocks and reservations when the specified events
                occur
              items:
                properties:
                  completionEntity:
                    $ref: >-
                      #/components/schemas/ReservationReleaseCompletionEntityEnum
                required:
                  - completionEntity
                type: object
              maxItems: 1
              minItems: 1
              type: array
          type: object
          x-badges:
            - color: red
              label: ALPHA
        stockModificationEnabled:
          default: true
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated Indicates if manual stock modification is allowed -
            will be moved to remoteConfig
          example: true
          type: boolean
      required:
        - stockModificationEnabled
      type: object
      title: StockConfigurationForCreation
    StockConfigurationForUpdate:
      allOf:
        - $ref: '#/components/schemas/StockConfigurationForCreation'
      description: Stock configuration data for updates
      properties:
        version:
          description: Version of the documentSet you want to update a document of
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      title: StockConfigurationForUpdate
    StockConfigurationPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyRetainedOfflineStock'
              - $ref: '#/components/schemas/ModifyListingReactivationAfter'
              - $ref: '#/components/schemas/ModifyShortpick'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: FacilityPatchActions
      title: StockConfigurationPatchActions
      description: StockConfigurationPatchActions
    StockDeleteActionResult:
      properties:
        ids:
          items:
            type: string
          type: array
      required:
        - ids
      title: StockDeleteActionResult
      type: object
      description: StockDeleteActionResult
    StockDeleteByIds:
      properties:
        ids:
          items:
            type: string
          maxItems: 500
          type: array
        name:
          enum:
            - DELETE_BY_IDS
          type: string
      required:
        - name
        - ids
      title: StockDeleteByIds
      type: object
      description: StockDeleteByIds
    StockDeleteByLocations:
      properties:
        locationRefs:
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          maxItems: 500
          type: array
        name:
          enum:
            - DELETE_BY_LOCATIONS
          type: string
      required:
        - name
        - locationRefs
      title: StockDeleteByLocations
      type: object
      description: StockDeleteByLocations
    StockDeleteByProducts:
      properties:
        facilityRef:
          type: string
        name:
          enum:
            - DELETE_BY_PRODUCTS
          type: string
        tenantArticleIds:
          items:
            type: string
          maxItems: 500
          type: array
      required:
        - name
        - facilityRef
        - tenantArticleIds
      title: StockDeleteByProducts
      type: object
      description: StockDeleteByProducts
    StockDistribution:
      properties:
        facilityStocks:
          items:
            $ref: '#/components/schemas/FacilityStockDistribution'
          type: array
        summary:
          $ref: '#/components/schemas/StockSummaryDetails'
        tenantArticleId:
          type: string
      required:
        - tenantArticleId
        - summary
        - facilityStocks
      title: StockDistribution
      type: object
      description: StockDistribution
    StockFacilityReferences:
      properties:
        facilityRef:
          description: facility in which the stock is located
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        tenantFacilityId:
          description: tenantFacilityId in which the stock is located
          example: MY_FACILITY_ID
          type: string
      required:
        - facilityRef
      title: StockFacilityReferences
      type: object
      description: StockFacilityReferences
    StockForCreation:
      properties:
        availableUntil:
          description: >-
            defines until when a stock is included in the stock availability as
            available and used for routing
          format: date-time
          type: string
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facility:
          description: >-
            Selector for the facility. Either a facility reference or a tenant
            facility ID must be provided.
          oneOf:
            - $ref: '#/components/schemas/FacilityRefSelector'
            - $ref: '#/components/schemas/TenantFacilityIdSelector'
        facilityRef:
          deprecated: true
          description: >-
            facility in which the stock is located - fill with either
            facilityRef or tenantFacilityId - Deprecated: use facility object
            instead
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        locationRef:
          description: location on which the stock is placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        properties:
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
            - additionalProperties:
                type: string
              type: object
          description: >-
            allow tracking of specific values such as expiry dates on a set of
            items. They should describe physical identifiable properties of the
            stock and are not meant to be used for metadata (see
            "customAttributes" for that).
        receiptDate:
          description: >-
            date-time when stock has entered the system, defaults to the
            creation date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock
          example: MY_ARTICLE_ID
          minLength: 1
          type: string
        tenantFacilityId:
          deprecated: true
          description: >-
            tenantFacilityId in which the stock is located - fill with either
            facilityRef or tenantFacilityId - Deprecated: use facility object
            instead
          example: MY_FACILITY_ID
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
      required:
        - tenantArticleId
        - value
      title: StockForCreation
      type: object
      description: StockForCreation
    StockForCreationVersionless:
      properties:
        availableUntil:
          description: >-
            defines until when a stock is included in the stock availability as
            available and used for routing
          format: date-time
          type: string
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facility:
          description: >-
            Selector for the facility. Either a facility reference or a tenant
            facility ID must be provided.
          oneOf:
            - $ref: '#/components/schemas/FacilityRefSelector'
            - $ref: '#/components/schemas/TenantFacilityIdSelector'
        facilityRef:
          deprecated: true
          description: >-
            facility in which the stock is located - fill with either
            facilityRef or tenantFacilityId - Deprecated: use facility object
            instead
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        locationRef:
          description: location on which the stock is placed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        operationType:
          enum:
            - CREATE
          type: string
        properties:
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
            - additionalProperties:
                type: string
              type: object
          description: >-
            allow tracking of specific values such as expiry dates on a set of
            items. They should describe physical identifiable properties of the
            stock and are not meant to be used for metadata (see
            "customAttributes" for that).
        receiptDate:
          description: >-
            date-time when stock has entered the system, defaults to the
            creation date
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        tenantArticleId:
          description: tenantArticleId of the stock
          example: MY_ARTICLE_ID
          minLength: 1
          type: string
        tenantFacilityId:
          deprecated: true
          description: >-
            tenantFacilityId in which the stock is located - fill with either
            facilityRef or tenantFacilityId - Deprecated: use facility object
            instead
          example: MY_FACILITY_ID
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
      required:
        - tenantArticleId
        - value
        - operationType
      title: StockForCreationVersionless
      type: object
      description: StockForCreationVersionless
    StockForUpdate:
      properties:
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        locationRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
        version:
          type: number
      required:
        - value
        - version
      title: StockForUpdate
      type: object
      description: StockForUpdate
    StockForUpdateVersionless:
      properties:
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        locationRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        operationType:
          enum:
            - UPDATE
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
      required:
        - value
        - id
        - operationType
      title: StockForUpdateVersionless
      type: object
      description: StockForUpdateVersionless
    StockForUpsertUpdate:
      properties:
        conditions:
          description: |-
            Describes conditions of a stock
                *`DEFECTIVE` - stock is defective, not usable for customer orders
          items:
            enum:
              - DEFECTIVE
            type: string
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          type: string
        locationRef:
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        tenantStockId:
          description: >-
            tenantStockId is an optional identifier for the stock in the tenant
            system.
          example: MY_STOCK_ID
          type: string
        traitConfig:
          description: >-
            defines the traits of the stock, overrules the storage location
            traits
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
        value:
          example: 42
          format: int32
          minimum: 0
          type: integer
        version:
          type: number
      required:
        - value
        - id
        - version
      title: StockForUpsertUpdate
      type: object
      description: StockForUpsertUpdate
    StockInformation:
      allOf:
        - $ref: '#/components/schemas/StockInformationForCreation'
        - properties:
            available:
              description: The actual available amount for this stock
              example: 24
              minimum: 0
              multipleOf: 1
              type: number
            reserved:
              example: 24
              minimum: 0
              multipleOf: 1
              type: number
      description: '@deprecated This object is deprecated since 11th of September 2023.'
      required:
        - available
      type: object
      title: StockInformation
    StockInformationForCreation:
      deprecated: true
      description: >-
        @deprecated This object is deprecated since 30th of November 2023. This
        object carries information about the current stock of this listing.
      properties:
        reserved:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />@deprecated This field is deprecated since 8th of February 2023.

            Reserved can't be overridden by the API, because its internally now
            handled by open PickJobs (or other upcoming ways to reserve Stock)

            Any Value provided will be ignored upon arrival.
          example: 24
          minimum: 0
          multipleOf: 1
          type: number
        stock:
          description: >-
            This the amount of the given article that is in stock for the given
            facility
          example: 42
          minimum: 0
          multipleOf: 1
          type: number
      required:
        - stock
      type: object
      title: StockInformationForCreation
    StockMoveToLocation:
      properties:
        amount:
          type: number
        fromStockId:
          type: string
        name:
          enum:
            - MOVE_TO_LOCATION
          type: string
        options:
          $ref: '#/components/schemas/MoveStockToLocationOptions'
        toLocationRef:
          type: string
      required:
        - name
        - fromStockId
        - toLocationRef
        - amount
      title: StockMoveToLocation
      type: object
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br
        />StockMoveToLocation
      x-badges:
        - color: orange
          label: BETA
    StockMoveToLocationActionResult:
      properties:
        fromStock:
          $ref: '#/components/schemas/Stock'
        toStock:
          $ref: '#/components/schemas/Stock'
      required:
        - toStock
      title: StockMoveToLocationActionResult
      type: object
      description: StockMoveToLocationActionResult
    StockPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        stocks:
          items:
            $ref: '#/components/schemas/Stock'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - stocks
      title: StockPaginatedResult
      type: object
      description: StockPaginatedResult
    StockPropertyDefinition:
      properties:
        defaultValue:
          description: >-
            This part of the API is in Alpha status. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />If {{NOW}} is provided, this will be replaced with a timestamp.
          type: string
          x-badges:
            - color: red
              label: ALPHA
        inputType:
          $ref: '#/components/schemas/StockPropertyInputType'
        required:
          description: Indicates if this property is required.
          type: boolean
      required:
        - inputType
        - required
      type: object
      title: StockPropertyDefinition
      description: StockPropertyDefinition
    StockPropertyInputType:
      description: Input Type for this property, used for clients.
      enum:
        - DATE
        - TEXT
      example: DATE
      type: string
      title: StockPropertyInputType
    StockPropertyPreset:
      properties:
        expiry:
          type: string
      title: StockPropertyPreset
      type: object
      description: StockPropertyPreset
    StockSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/StockSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/StockSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: StockSearchPayload
      type: object
      description: StockSearchPayload
    StockSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/StockSearchQuery'
          maxItems: 500
          type: array
        availableUntil:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by availableUntil
        conditions:
          allOf:
            - $ref: '#/components/schemas/StockConditionEnumListFilter'
          description: Search by conditions
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        locationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by locationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/StockSearchQuery'
          maxItems: 500
          type: array
        properties:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/StringFilter'
              - $ref: '#/components/schemas/DateFilter'
              - $ref: '#/components/schemas/KeyExistsFilter'
          description: Search by properties
          type: object
        receiptDate:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by receiptDate
          example: 2026-06-17T12:00:00.000Z
        scannableCodes:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by scannableCodes
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
        tenantFacilityId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: >-
            tenantFacilityId is handled like facilityRef filter, if you want to
            search by both you should wrap that filter in an "or" filter
          example: MY_FACILITY_ID
        tenantStockId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantStockId
          example: MY_STOCK_ID
        traits:
          allOf:
            - $ref: '#/components/schemas/StockStorageLocationTraitEnumListFilter'
          description: Search by traits
        value:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by value
      title: StockSearchQuery
      type: object
      description: StockSearchQuery
    StockSelectionSection:
      properties:
        diagnostics:
          items:
            $ref: '#/components/schemas/PickingOutcomeDiagnostic'
          type: array
      required:
        - diagnostics
      title: StockSelectionSection
      type: object
      description: StockSelectionSection
    StocksForUpsert:
      properties:
        stocks:
          description: >-
            Please be sure to include each stock (by ID) only once, when
            updating. Otherwise the whole batch is rejected with an error.
          items:
            oneOf:
              - $ref: '#/components/schemas/StockForCreation'
              - $ref: '#/components/schemas/StockForUpsertUpdate'
              - not:
                  required:
                    - version
                properties:
                  id:
                    type: string
                  locationRef:
                    nullable: true
                    type: string
                  value:
                    format: int32
                    minimum: 0
                    type: integer
                required:
                  - id
                  - value
                type: object
          maxItems: 500
          type: array
      required:
        - stocks
      title: StocksForUpsert
      type: object
      description: StocksForUpsert
    StockSort:
      properties:
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        locationName:
          enum:
            - ASC
            - DESC
          type: string
        tenantArticleId:
          enum:
            - ASC
            - DESC
          type: string
        value:
          enum:
            - ASC
            - DESC
          type: string
      title: StockSort
      type: object
      description: StockSort
    StockStorageLocationTraitEnumFilter:
      properties:
        eq:
          description: Search by traits
          enum:
            - PICKABLE
            - ACCESSIBLE
            - KEEP_ON_ZERO
            - OUTBOUND
            - IN_MOTION
          type: string
        in:
          description: Search by traits
          items:
            enum:
              - PICKABLE
              - ACCESSIBLE
              - KEEP_ON_ZERO
              - OUTBOUND
              - IN_MOTION
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by traits
          enum:
            - PICKABLE
            - ACCESSIBLE
            - KEEP_ON_ZERO
            - OUTBOUND
            - IN_MOTION
          type: string
      title: StockStorageLocationTraitEnumFilter
      type: object
      description: StockStorageLocationTraitEnumFilter
    StockStorageLocationTraitEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/StockStorageLocationTraitEnumFilter'
          description: Search by traits
      title: StockStorageLocationTraitEnumListFilter
      type: object
      description: StockStorageLocationTraitEnumListFilter
    StockSummaries:
      properties:
        stockSummaries:
          items:
            $ref: '#/components/schemas/StockSummary'
          type: array
        total:
          minimum: 0
          type: number
      required:
        - total
        - stockSummaries
      title: StockSummaries
      type: object
      description: StockSummaries
    StockSummary:
      properties:
        article:
          $ref: '#/components/schemas/StockSummaryArticle'
        details:
          $ref: '#/components/schemas/StockSummaryDetails'
        includedFacilityRefs:
          description: >-
            ALPHA Status!. The facilityRefs that are included in the stock
            summary.
          example:
            - 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
            - 0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f
          items:
            type: string
          type: array
      required:
        - includedFacilityRefs
        - article
        - details
      title: StockSummary
      type: object
      description: StockSummary
    StockSummaryArticle:
      properties:
        imageUrl:
          type: string
        tenantArticleId:
          type: string
        title:
          type: string
      required:
        - tenantArticleId
        - title
      title: StockSummaryArticle
      type: object
      description: StockSummaryArticle
    StockSummaryDetails:
      properties:
        available:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          minimum: 0
          type: number
        availableForPicking:
          type: number
        availableOnStock:
          type: number
        availableToPromise:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        byTrait:
          $ref: '#/components/schemas/ByTrait'
        channelAdjusted:
          items:
            $ref: '#/components/schemas/ChannelStockAvailability'
          type: array
        readyToPick:
          deprecated: true
          description: >-
            This field is deprecated and replaced by new availability concepts.
            See
            https://docs.fulfillmenttools.com/documentation/by-pillar/global-inventory-hub/stock/stock-availability
            for more information.
          type: number
        reserved:
          minimum: 0
          type: number
        safetyStock:
          minimum: 0
          type: number
        stockOnHand:
          type: number
        totalAmount:
          minimum: 0
          type: number
      required:
        - reserved
        - totalAmount
        - available
        - safetyStock
        - byTrait
        - availableForPicking
        - availableToPromise
        - readyToPick
        - availableOnStock
        - stockOnHand
      title: StockSummaryDetails
      type: object
      description: StockSummaryDetails
    StockUpsertOperationResult:
      properties:
        status:
          enum:
            - UPDATED
            - CREATED
            - UNCHANGED
          type: string
        stock:
          $ref: '#/components/schemas/Stock'
      required:
        - stock
        - status
      title: StockUpsertOperationResult
      type: object
      description: StockUpsertOperationResult
    StockVersionlessUpsertActionResult:
      properties:
        operationResults:
          $ref: '#/components/schemas/StockUpsertOperationResult'
      required:
        - operationResults
      title: StockVersionlessUpsertActionResult
      type: object
      description: StockVersionlessUpsertActionResult
    StorageLocation:
      allOf:
        - $ref: '#/components/schemas/StorageLocationForReplacement'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        facilityRef:
          description: The id of the facility reference.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        id:
          description: The id of this storage location
          type: string
        schemaVersion:
          type: number
        traitConfig:
          $ref: '#/components/schemas/StorageLocationTraitConfig'
        traits:
          description: The traits of this storage location
          items:
            $ref: '#/components/schemas/StorageLocationTrait'
          type: array
        zoneName:
          deprecated: true
          description: >-
            Deprecated! This field will not be filled in newly created storage
            locations. Resolve the zone name separately via the
            facilities/{id}/zones endpoint. The name of the Zone to which this
            storage location belongs
          type: string
      required:
        - id
        - facilityRef
        - traits
      type: object
      xml:
        name: StorageLocation
      title: StorageLocation
      description: StorageLocation
    StorageLocationAssignmentConfiguration:
      additionalProperties: false
      properties:
        storageLocationRequired:
          enum:
            - ALL
            - SOME
            - NONE
          type: string
      required:
        - storageLocationRequired
      type: object
      title: StorageLocationAssignmentConfiguration
      description: StorageLocationAssignmentConfiguration
    StorageLocationBulkEventPayload:
      properties:
        items:
          items:
            $ref: '#/components/schemas/StorageLocationEventPayload'
          type: array
      required:
        - items
      title: StorageLocationBulkEventPayload
      type: object
      description: StorageLocationBulkEventPayload
    StorageLocationBulkWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/StorageLocationBulkEventPayload'
      required:
        - payload
      title: StorageLocationBulkWebHookEvent
      type: object
      description: StorageLocationBulkWebHookEvent
    StorageLocationEventPayload:
      properties:
        created:
          description: >-
            The date this entity was created by fulfillmenttools. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        id:
          type: string
        information:
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        name:
          type: string
        runningSequences:
          items:
            $ref: '#/components/schemas/StorageLocationEventSequenceItem'
          type: array
        scannableCodes:
          items:
            type: string
          type: array
        tenantLocationId:
          type: string
        traitConfig:
          items:
            $ref: '#/components/schemas/StorageLocationEventTraitConfigInner'
          type: array
        traits:
          items:
            $ref: '#/components/schemas/StorageLocationTrait'
          type: array
        type:
          $ref: '#/components/schemas/StorageLocationType'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        zoneName:
          type: string
        zoneRef:
          type: string
      required:
        - version
        - id
        - facilityRef
        - traits
        - name
        - type
        - scannableCodes
        - runningSequences
      title: StorageLocationEventPayload
      type: object
      description: StorageLocationEventPayload
    StorageLocationEventSequenceItem:
      properties:
        nextStorageLocationRef:
          type: string
        previousStorageLocationRef:
          type: string
        score:
          type: number
        type:
          $ref: '#/components/schemas/StorageLocationSequenceType'
      required:
        - type
      title: StorageLocationEventSequenceItem
      type: object
      description: StorageLocationEventSequenceItem
    StorageLocationEventTraitConfigInner:
      properties:
        enabled:
          type: boolean
        trait:
          $ref: '#/components/schemas/StorageLocationTrait'
      required:
        - trait
        - enabled
      title: StorageLocationEventTraitConfigInner
      type: object
      description: StorageLocationEventTraitConfigInner
    StorageLocationForCreation:
      allOf:
        - $ref: '#/components/schemas/CustomAttributesResource'
      properties:
        information:
          description: A free text information about this storage location, max length 1024
          maxLength: 1024
          type: string
        name:
          description: The name of this storage location
          maxLength: 15
          type: string
        runningSequences:
          description: The Sequence item/s of this location
          items:
            $ref: '#/components/schemas/StorageLocationSequenceItem'
          maxItems: 10
          type: array
        scannableCodes:
          description: Barcodes representing this storage location
          items:
            type: string
          maxItems: 5
          type: array
        tenantLocationId:
          description: The internal tenant id for this location
          type: string
        traitConfig:
          $ref: '#/components/schemas/StorageLocationTraitConfig'
        traits:
          description: >-
            The traits of this storage location, includes both local config and
            and defaults. Do not use to write to traits, use traitConfig
            instead.
          items:
            $ref: '#/components/schemas/StorageLocationTrait'
          type: array
        type:
          $ref: '#/components/schemas/StorageLocationType'
        zoneName:
          description: The name of the Zone to which this storage location belongs
          type: string
        zoneRef:
          description: The id of the Zone to which this storage location belongs
          example: Esb20gpHBL94X5NdMp3C
          type: string
      required:
        - name
        - runningSequences
        - scannableCodes
        - type
      type: object
      xml:
        name: StorageLocationForCreation
      title: StorageLocationForCreation
      description: StorageLocationForCreation
    StorageLocationForReplacement:
      allOf:
        - $ref: '#/components/schemas/StorageLocationForCreation'
      properties:
        version:
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      xml:
        name: StorageLocationForReplacement
      title: StorageLocationForReplacement
      description: StorageLocationForReplacement
    StorageLocationPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        storageLocations:
          items:
            $ref: '#/components/schemas/StorageLocation'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - storageLocations
      title: StorageLocationPaginatedResult
      type: object
      description: StorageLocationPaginatedResult
    StorageLocationPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyStorageLocationAction'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the facility where we want to patch the storage
            locations to be used in optimistic locking mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: StorageLocationPatchActions
      title: StorageLocationPatchActions
      description: StorageLocationPatchActions
    StorageLocationRecommendation:
      properties:
        stockCount:
          type: number
        storageLocation:
          $ref: '#/components/schemas/StorageLocation'
      required:
        - storageLocation
        - stockCount
      title: StorageLocationRecommendation
      type: object
      description: StorageLocationRecommendation
    StorageLocationReferencedFilter:
      properties:
        stock:
          allOf:
            - $ref: '#/components/schemas/StorageLocationReferencedStockFilter'
          description: Nested search by stock
      title: StorageLocationReferencedFilter
      type: object
      description: StorageLocationReferencedFilter
    StorageLocationReferencedStockFilter:
      properties:
        hasStocks:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Whether the storage locations has any stocks on it.
        sumOfValues:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: >-
            The sum of all stock values in this storage location, i.e. how much
            stock is stored in this location.
      title: StorageLocationReferencedStockFilter
      type: object
      description: StorageLocationReferencedStockFilter
    StorageLocationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/StorageLocationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/StorageLocationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: StorageLocationSearchPayload
      type: object
      description: StorageLocationSearchPayload
    StorageLocationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/StorageLocationSearchQuery'
          maxItems: 500
          type: array
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        name:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/StorageLocationSearchQuery'
          maxItems: 500
          type: array
        referenced:
          allOf:
            - $ref: '#/components/schemas/StorageLocationReferencedFilter'
          description: Nested search by referenced
        scannableCodes:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by scannableCodes
        tenantLocationId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantLocationId
          example: MY_LOCATION_ID
        traits:
          allOf:
            - $ref: '#/components/schemas/StorageLocationTraitEnumListFilter'
          description: Search by traits
        type:
          allOf:
            - $ref: '#/components/schemas/StorageLocationTypeEnumFilter'
          description: Search by type
        zoneRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by zoneRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: StorageLocationSearchQuery
      type: object
      description: StorageLocationSearchQuery
    StorageLocationSequenceItem:
      properties:
        nextStorageLocationRef:
          description: The next storage from which to pick up after this one
          type: string
        previousStorageLocationRef:
          description: The previous storage from which to pick up after this one
          type: string
        score:
          deprecated: true
          description: Running sequence score - read-only
          type: number
        type:
          $ref: '#/components/schemas/StorageLocationSequenceType'
      required:
        - type
      type: object
      xml:
        name: StorageLocationSequenceItem
      title: StorageLocationSequenceItem
      description: StorageLocationSequenceItem
    StorageLocationSequenceType:
      description: |-
        Describes the type of a storage location sequence type
          * `PICKING_SEQUENCE`- The sequence in wich the storage locations are picked.
          * `RESTOW_SEQUENCE`- The sequence in wich the storage locations are restowed.
      enum:
        - PICKING_SEQUENCE
        - RESTOW_SEQUENCE
      type: string
      xml:
        name: StorageLocationType
      title: StorageLocationSequenceType
    StorageLocationSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        name:
          enum:
            - ASC
            - DESC
          type: string
        tenantLocationId:
          enum:
            - ASC
            - DESC
          type: string
        zoneRef:
          enum:
            - ASC
            - DESC
          type: string
      title: StorageLocationSort
      type: object
      description: StorageLocationSort
    StorageLocationTrait:
      description: |-
        Describes what kind of actions this stock is available for
          * `PICKABLE`- The stock is available for picking
          * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)
          * `KEEP_ON_ZERO`- The stock will not be deleted when emptied
          * `OUTBOUND`- The stock is intended for outbound processes
          * `IN_MOTION`- The stock is in motion, used by StowJobs.
      enum:
        - PICKABLE
        - ACCESSIBLE
        - KEEP_ON_ZERO
        - OUTBOUND
        - IN_MOTION
      type: string
      xml:
        name: StorageLocationTrait
      title: StorageLocationTrait
    StorageLocationTraitConfig:
      description: The configuration of the traits of this storage location
      items:
        properties:
          enabled:
            type: boolean
          trait:
            $ref: '#/components/schemas/StorageLocationTrait'
        required:
          - trait
          - enabled
        type: object
      type: array
      title: StorageLocationTraitConfig
    StorageLocationTraitConfigEntry:
      properties:
        enabled:
          description: whether the trait is enabled or not
          type: boolean
        trait:
          description: |-
            Describes what kind of actions this stock is available for
                 * `PICKABLE`- The stock is available for picking
                 * `ACCESSIBLE`- The stock is available for stock movements (stowing, inbound, etc)
                 * `KEEP_ON_ZERO`- The stock will not be deleted when emptied
                 * `OUTBOUND`- The stock is intended for outbound processes
          type: string
      required:
        - enabled
        - trait
      title: StorageLocationTraitConfigEntry
      type: object
      description: StorageLocationTraitConfigEntry
    StorageLocationTraitEnumFilter:
      properties:
        eq:
          description: Search by traits
          enum:
            - PICKABLE
            - ACCESSIBLE
            - KEEP_ON_ZERO
            - OUTBOUND
            - IN_MOTION
          type: string
        in:
          description: Search by traits
          items:
            enum:
              - PICKABLE
              - ACCESSIBLE
              - KEEP_ON_ZERO
              - OUTBOUND
              - IN_MOTION
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by traits
          enum:
            - PICKABLE
            - ACCESSIBLE
            - KEEP_ON_ZERO
            - OUTBOUND
            - IN_MOTION
          type: string
      title: StorageLocationTraitEnumFilter
      type: object
      description: StorageLocationTraitEnumFilter
    StorageLocationTraitEnumListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/StorageLocationTraitEnumFilter'
          description: Search by traits
      title: StorageLocationTraitEnumListFilter
      type: object
      description: StorageLocationTraitEnumListFilter
    StorageLocationType:
      description: |-
        Describes the kind of a storage location:
          * `SINGLE_STORAGE`- it is only allowed to store stock with the same tenantArticleId here
          * `BULK_STORAGE`- stocks belonging to different tenantArticleIds can be stored here
      enum:
        - SINGLE_STORAGE
        - BULK_STORAGE
      type: string
      xml:
        name: StorageLocationType
      title: StorageLocationType
    StorageLocationTypeEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - SINGLE_STORAGE
            - BULK_STORAGE
          type: string
        in:
          description: Search by type
          items:
            enum:
              - SINGLE_STORAGE
              - BULK_STORAGE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - SINGLE_STORAGE
            - BULK_STORAGE
          type: string
      title: StorageLocationTypeEnumFilter
      type: object
      description: StorageLocationTypeEnumFilter
    StowedStowLineItemStowTo:
      properties:
        stowedAt:
          description: Time and date on which the item was stowed
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        stowedQuantity:
          description: Quantity that was stowed
          type: number
        stowedStockRef:
          description: >-
            Specifies the stock where the item will be stowed. Set this to null
            to explicitly create a new stock. 
             Exception: If stowTo.type is "DISCARD", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        stowedStorageLocationRef:
          description: >-
            If a new stock is created via stowedStockRef = null, this is used to
            set the storage location of the new stock. 
             If a stock is specified, this field will be ignored.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - stowedStockRef
        - stowedQuantity
      title: StowedStowLineItemStowTo
      type: object
      description: StowedStowLineItemStowTo
    StowedStowLineItemStowToForCreation:
      properties:
        stowedAt:
          description: >-
            Time and date on which the item was stowed. Will be set to the
            current time if not provided.
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        stowedQuantity:
          description: Quantity that was stowed
          type: number
        stowedStockRef:
          description: >-
            Specifies the stock where the item will be stowed. Set this to null
            to explicitly create a new stock. 
             Exception: If stowTo.type is "DISCARD", a new stock will not be created when set to `null`. However, if a stock is specified, its quantity will be increased regardless of the type.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
        stowedStorageLocationRef:
          description: >-
            If a new stock is created via stowedStockRef = null, this is used to
            set the storage location of the new stock. 
             If a stock is specified, this field will be ignored.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - stowedStockRef
        - stowedQuantity
      title: StowedStowLineItemStowToForCreation
      type: object
      description: StowedStowLineItemStowToForCreation
    StowJob:
      properties:
        assignedUsers:
          description: The users that are assigned to the stow job
          items:
            $ref: '#/components/schemas/AssignedUser'
          maxItems: 20
          type: array
        created:
          description: Creation date of the entity, auto-generated if not provided
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: >-
            Non-human-readable reference to the facility where the stow job is
            executed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: Auto-generated, unique primary identifier of the stow job
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: Service-generated last modification date of the entity
          format: date-time
          type: string
        priority:
          description: Priority level of the job
          type: number
        shortId:
          description: Readable identifier for display purposes, not unique.
          type: string
        status:
          description: The status of the stowJob
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - CANCELED
            - PAUSED
          type: string
        stowLineItems:
          description: The line items that should be stowed
          items:
            $ref: '#/components/schemas/StowLineItem'
          type: array
        targetTime:
          description: >-
            The time by which the job should be completed. Use for
            prioritization and scheduling
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        version:
          description: The version of the entity, used for optimistic locking mechanisms
          example: 1
          type: number
      required:
        - facilityRef
        - status
        - stowLineItems
        - id
        - version
      title: StowJob
      type: object
      description: StowJob
    StowJobActionName:
      description: The name of the action that should be performed
      enum:
        - START_STOW_JOB
        - PAUSE_STOW_JOB
        - OPEN_STOW_JOB
        - CANCEL_STOW_JOB
        - CLOSE_STOW_JOB
        - MODIFY_STOW_LINE_ITEMS
        - REPLACE_ASSIGNED_USERS
      type: string
      xml:
        name: StowJobActionName
      title: StowJobActionName
    StowJobForCreation:
      properties:
        assignedUsers:
          description: The users that are assigned to the stow job
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationById'
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUser'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: >-
            Non-human-readable reference to the facility where the stow job is
            executed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        priority:
          description: Priority level of the job
          type: number
        shortId:
          description: Readable identifier for display purposes, not unique.
          type: string
        status:
          description: The status of the stowJob
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - CANCELED
            - PAUSED
          type: string
        stowLineItems:
          description: The line items that should be stowed
          items:
            $ref: '#/components/schemas/StowLineItemForCreation'
          type: array
        targetTime:
          description: >-
            The time by which the job should be completed. Use for
            prioritization and scheduling
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
      required:
        - facilityRef
        - status
        - stowLineItems
      title: StowJobForCreation
      type: object
      description: StowJobForCreation
    StowJobForPatch:
      properties:
        assignedUsers:
          description: The users that are assigned to the stow job
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationById'
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUser'
          maxItems: 20
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        priority:
          description: Information for user about which job should be started first
          type: number
        targetTime:
          format: date-time
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms
          example: 1
          type: number
      required:
        - version
      title: StowJobForPatch
      type: object
      description: StowJobForPatch
    StowJobPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        stowJobs:
          items:
            $ref: '#/components/schemas/StowJob'
          type: array
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
      required:
        - pageInfo
        - stowJobs
      title: StowJobPaginatedResult
      type: object
      description: StowJobPaginatedResult
    StowJobReplaceAssignedUsersAction:
      description: REPLACE_ASSIGNED_USERS replaces the assigned users of the stow job
      properties:
        assignedUsers:
          description: The users are assigned to the stow job
          items:
            anyOf:
              - $ref: '#/components/schemas/AssignedUserForCreationById'
              - $ref: '#/components/schemas/AssignedUserForCreationByName'
              - $ref: '#/components/schemas/AssignedUser'
          maxItems: 20
          type: array
        name:
          description: The name of the action that should be performed
          enum:
            - REPLACE_ASSIGNED_USERS
          type: string
        version:
          description: The current version of the stow job that should be modified
          example: 1
          type: number
      required:
        - version
        - name
        - assignedUsers
      title: StowJobReplaceAssignedUsersAction
      type: object
    StowJobSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/StowJobSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/StowJobSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: StowJobSearchPayload
      type: object
      description: StowJobSearchPayload
    StowJobSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/StowJobSearchQuery'
          maxItems: 500
          type: array
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          default:
            after: '-P1W'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
          example:
            after: '-P1W'
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/StowJobSearchQuery'
          maxItems: 500
          type: array
        priority:
          allOf:
            - $ref: '#/components/schemas/NumberFilter'
          description: Search by priority
        shortId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shortId
        status:
          allOf:
            - $ref: '#/components/schemas/StowJobStatusTypeEnumFilter'
          description: Search by status
        stowLineItems:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsListFilter'
          description: Nested list search by stowLineItems
        targetTime:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by targetTime
          example: 2026-06-17T12:00:00.000Z
      title: StowJobSearchQuery
      type: object
      description: StowJobSearchQuery
    StowJobSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
        targetTime:
          enum:
            - ASC
            - DESC
          type: string
      title: StowJobSort
      type: object
      description: StowJobSort
    StowJobStatus:
      description: The status of the stowJob
      enum:
        - OPEN
        - IN_PROGRESS
        - CLOSED
        - CANCELED
        - PAUSED
      type: string
      xml:
        name: StowJobStatus
      title: StowJobStatus
    StowJobStatusTypeEnumFilter:
      properties:
        eq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - CANCELED
            - PAUSED
          type: string
        in:
          description: Search by status
          items:
            enum:
              - OPEN
              - IN_PROGRESS
              - CLOSED
              - CANCELED
              - PAUSED
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by status
          enum:
            - OPEN
            - IN_PROGRESS
            - CLOSED
            - CANCELED
            - PAUSED
          type: string
      title: StowJobStatusTypeEnumFilter
      type: object
      description: StowJobStatusTypeEnumFilter
    StowJobStockInformation:
      properties:
        properties:
          additionalProperties:
            type: string
          allOf:
            - $ref: '#/components/schemas/StockPropertyPreset'
          description: >-
            allow tracking of specific values such as expiry dates on a set of
            items. They should describe physical identifiable properties of the
            stock and are not meant to be used for metadata (see
            "customAttributes" for that).
        traitConfig:
          items:
            $ref: '#/components/schemas/StorageLocationTraitConfigEntry'
          type: array
      title: StowJobStockInformation
      type: object
      description: StowJobStockInformation
    StowJobStowLineItemsArticleFilter:
      properties:
        tenantArticleId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantArticleId
          example: MY_ARTICLE_ID
      title: StowJobStowLineItemsArticleFilter
      type: object
      description: StowJobStowLineItemsArticleFilter
    StowJobStowLineItemsFilter:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsArticleFilter'
          description: Nested search by article
        heldStockRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by heldStockRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        stowTo:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsStowToListFilter'
          description: Nested list search by stowTo
        takeFrom:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsTakeFromFilter'
          description: Nested search by takeFrom
      title: StowJobStowLineItemsFilter
      type: object
      description: StowJobStowLineItemsFilter
    StowJobStowLineItemsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: StowJobStowLineItemsListFilter
      type: object
      description: StowJobStowLineItemsListFilter
    StowJobStowLineItemsStowToFilter:
      properties:
        storageLocationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by storageLocationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        stowed:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsStowToStowedFilter'
          description: Nested search by stowed
        type:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by type
      title: StowJobStowLineItemsStowToFilter
      type: object
      description: StowJobStowLineItemsStowToFilter
    StowJobStowLineItemsStowToListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsStowToFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: StowJobStowLineItemsStowToListFilter
      type: object
      description: StowJobStowLineItemsStowToListFilter
    StowJobStowLineItemsStowToStowedFilter:
      properties:
        stowedStockRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by stowedStockRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        stowedStorageLocationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by stowedStorageLocationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: StowJobStowLineItemsStowToStowedFilter
      type: object
      description: StowJobStowLineItemsStowToStowedFilter
    StowJobStowLineItemsTakeFromFilter:
      properties:
        storageLocationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by storageLocationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        taken:
          allOf:
            - $ref: '#/components/schemas/StowJobStowLineItemsTakeFromTakenFilter'
          description: Nested search by taken
        type:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by type
      title: StowJobStowLineItemsTakeFromFilter
      type: object
      description: StowJobStowLineItemsTakeFromFilter
    StowJobStowLineItemsTakeFromTakenFilter:
      properties:
        takenStockRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by takenStockRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: StowJobStowLineItemsTakeFromTakenFilter
      type: object
      description: StowJobStowLineItemsTakeFromTakenFilter
    StowJobWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/StowJob'
      required:
        - payload
      title: StowJobWebHookEvent
      type: object
      description: StowJobWebHookEvent
    StowLineItem:
      properties:
        article:
          $ref: '#/components/schemas/StowLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        heldStockRef:
          description: >-
            Reference to a stock holding the goods after a take and before a
            stow has taken place
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: >-
            The ID of the stowLineItem. It is generated automatically during
            creation and serves as primary identifier of the entity
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        reasons:
          description: The reasons for the stow operation
          items:
            $ref: '#/components/schemas/ExternalStockChangeReasonOutput'
          maxItems: 10
          type: array
        stowTo:
          description: Instructions on how and where to stow the item
          items:
            $ref: '#/components/schemas/StowLineItemStowToWithId'
          type: array
        takeFrom:
          allOf:
            - $ref: '#/components/schemas/StowLineItemTakeFrom'
          description: Instructions on how and where to take the item from
      required:
        - article
        - stowTo
        - takeFrom
        - id
      title: StowLineItem
      type: object
      description: StowLineItem
    StowLineItemArticle:
      properties:
        titleLocalized:
          description: The translations for the title of the item
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        imageUrl:
          description: >-
            A web link to a picture of this item. Please make sure that no
            authentication is required to fetch the image!
          example: https://example.com/resource
          type: string
        measurementUnitKey:
          description: Identifier for the item's unit of measurement
          type: string
        scannableCodes:
          description: ScannableCodes such as barcodes related to the item
          items:
            type: string
          type: array
        tenantArticleId:
          description: Identifier for a certain product which the StowLineItem refers to
          example: MY_ARTICLE_ID
          type: string
        title:
          description: The title of the item
          type: string
      required:
        - tenantArticleId
      title: StowLineItemArticle
      type: object
      description: StowLineItemArticle
    StowLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/StowLineItemArticle'
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        reasons:
          description: >-
            The reasons for the stow operation. Each reason can either be a
            stand-alone reason, or a preconfigured reasons by specifying the
            tenantReasonId and/or the id of the reason. If tenantReasonId and id
            are specified, they have to match.
          items:
            $ref: '#/components/schemas/ExternalStockChangeReasonInput'
          maxItems: 10
          type: array
        stowTo:
          description: Instructions on how and where to stow the item
          items:
            $ref: '#/components/schemas/StowLineItemStowToForCreation'
          type: array
        takeFrom:
          allOf:
            - $ref: '#/components/schemas/StowLineItemTakeFromForCreation'
          description: Instructions on how and where to take the item from
      required:
        - article
        - stowTo
        - takeFrom
      title: StowLineItemForCreation
      type: object
      description: StowLineItemForCreation
    StowLineItemForUpdate:
      properties:
        article:
          allOf:
            - $ref: '#/components/schemas/StowLineItemArticle'
          description: The article that should be stowed
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        id:
          description: The ID of the stowLineItem. Leave empty for creation
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        reasons:
          description: The reasons for the stow operation
          items:
            $ref: '#/components/schemas/ExternalStockChangeReasonInput'
          maxItems: 10
          type: array
        stowTo:
          description: Instructions on how and where to stow the item
          items:
            $ref: '#/components/schemas/StowLineItemStowToForUpdate'
          type: array
        takeFrom:
          allOf:
            - $ref: '#/components/schemas/StowLineItemTakeFromForCreation'
          description: Instructions on how and where to take the item from
      title: StowLineItemForUpdate
      type: object
      description: StowLineItemForUpdate
    StowLineItemStowTo:
      properties:
        quantity:
          description: Quantity that should be taken / stowed
          type: number
        scannableCodes:
          description: >-
            ScannableCodes such as barcodes relevant for taking or stowing the
            item
          items:
            type: string
          type: array
        stockRef:
          description: >-
            Stock from which the item should be taken / stowed to. Leave empty
            for type UNREGISTERED / DISCARD.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            Storage location from which the item should be taken or to which the
            item should be stowed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        stowed:
          allOf:
            - $ref: '#/components/schemas/StowedStowLineItemStowTo'
          description: >-
            Operative data holding information about the stowing progress. **As
            for now stocks will *not* be updated even if the numbers indicate so
            because the stow job feature is still under development.**
        type:
          description: >-
            Define if items should be stowed on a specific stock or storage
            location. Use type DISCARD if the item should be booked out of the
            system
          enum:
            - STOCK
            - LOCATION
            - DISCARD
          type: string
      required:
        - quantity
        - type
      title: StowLineItemStowTo
      type: object
      description: StowLineItemStowTo
    StowLineItemStowToForCreation:
      properties:
        quantity:
          description: Quantity that should be taken / stowed
          type: number
        scannableCodes:
          description: >-
            ScannableCodes such as barcodes relevant for taking or stowing the
            item
          items:
            type: string
          type: array
        stockRef:
          description: >-
            Stock from which the item should be taken / stowed to. Leave empty
            for type UNREGISTERED / DISCARD.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            Storage location from which the item should be taken or to which the
            item should be stowed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        stowed:
          allOf:
            - $ref: '#/components/schemas/StowedStowLineItemStowToForCreation'
          description: >-
            Operative data holding information about the stowing progress. **As
            for now stocks will *not* be updated even if the numbers indicate so
            because the stow job feature is still under development.**
        type:
          description: >-
            Define if items should be stowed on a specific stock or storage
            location. Use type DISCARD if the item should be booked out of the
            system
          enum:
            - STOCK
            - LOCATION
            - DISCARD
          type: string
      required:
        - quantity
        - type
      title: StowLineItemStowToForCreation
      type: object
      description: StowLineItemStowToForCreation
    StowLineItemStowToForUpdate:
      properties:
        id:
          type: string
        quantity:
          description: Quantity that should be taken / stowed
          type: number
        scannableCodes:
          description: >-
            ScannableCodes such as barcodes relevant for taking or stowing the
            item
          items:
            type: string
          type: array
        stockRef:
          description: >-
            Stock from which the item should be taken / stowed to. Leave empty
            for type UNREGISTERED / DISCARD.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            Storage location from which the item should be taken or to which the
            item should be stowed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        stowed:
          allOf:
            - $ref: '#/components/schemas/StowedStowLineItemStowToForCreation'
          description: >-
            Operative data holding information about the stowing progress. **As
            for now stocks will *not* be updated even if the numbers indicate so
            because the stow job feature is still under development.**
        type:
          description: >-
            Define if items should be stowed on a specific stock or storage
            location. Use type DISCARD if the item should be booked out of the
            system
          enum:
            - STOCK
            - LOCATION
            - DISCARD
          type: string
      required:
        - quantity
        - type
      title: StowLineItemStowToForUpdate
      type: object
      description: StowLineItemStowToForUpdate
    StowLineItemStowToType:
      description: >-
        Define if items should be stowed on a specific stock or storage
        location. Use type DISCARD if the item should be booked out of the
        system
      enum:
        - STOCK
        - LOCATION
        - DISCARD
      type: string
      xml:
        name: StowLineItemStowToType
      title: StowLineItemStowToType
    StowLineItemStowToWithId:
      properties:
        id:
          description: The ID of the stowTo instruction
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        quantity:
          description: Quantity that should be taken / stowed
          type: number
        scannableCodes:
          description: >-
            ScannableCodes such as barcodes relevant for taking or stowing the
            item
          items:
            type: string
          type: array
        stockRef:
          description: >-
            Stock from which the item should be taken / stowed to. Leave empty
            for type UNREGISTERED / DISCARD.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            Storage location from which the item should be taken or to which the
            item should be stowed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        stowed:
          allOf:
            - $ref: '#/components/schemas/StowedStowLineItemStowTo'
          description: >-
            Operative data holding information about the stowing progress. **As
            for now stocks will *not* be updated even if the numbers indicate so
            because the stow job feature is still under development.**
        type:
          description: >-
            Define if items should be stowed on a specific stock or storage
            location. Use type DISCARD if the item should be booked out of the
            system
          enum:
            - STOCK
            - LOCATION
            - DISCARD
          type: string
      required:
        - quantity
        - type
        - id
      title: StowLineItemStowToWithId
      type: object
      description: StowLineItemStowToWithId
    StowLineItemTakeFrom:
      properties:
        quantity:
          description: Quantity that should be taken / stowed
          type: number
        scannableCodes:
          description: >-
            ScannableCodes such as barcodes relevant for taking or stowing the
            item
          items:
            type: string
          type: array
        stockInformation:
          allOf:
            - $ref: '#/components/schemas/StowJobStockInformation'
          description: >-
            Additional information about the newly created stock. **Only allowed
            for type UNREGISTERED**
        stockRef:
          description: >-
            Stock from which the item should be taken / stowed to. Leave empty
            for type UNREGISTERED / DISCARD.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            Storage location from which the item should be taken or to which the
            item should be stowed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        taken:
          allOf:
            - $ref: '#/components/schemas/TakenStowLineItemTakeFrom'
          description: >-
            Operative data holding information about the stowing progress. **As
            for now stocks will *not* be updated even if the numbers indicate so
            because the stow job feature is still under development.**
        type:
          description: >-
            Define if items should be taken from specific stock or storage
            location. Use type UNREGISTERED if a new item should be booked into
            the system
          enum:
            - STOCK
            - LOCATION
            - UNREGISTERED
          type: string
      required:
        - quantity
        - type
      title: StowLineItemTakeFrom
      type: object
      description: StowLineItemTakeFrom
    StowLineItemTakeFromForCreation:
      properties:
        quantity:
          description: Quantity that should be taken / stowed
          type: number
        scannableCodes:
          description: >-
            ScannableCodes such as barcodes relevant for taking or stowing the
            item
          items:
            type: string
          type: array
        stockInformation:
          allOf:
            - $ref: '#/components/schemas/StowJobStockInformation'
          description: >-
            Additional information about the newly created stock. **Only allowed
            for type UNREGISTERED**
        stockRef:
          description: >-
            Stock from which the item should be taken / stowed to. Leave empty
            for type UNREGISTERED / DISCARD.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        storageLocationRef:
          description: >-
            Storage location from which the item should be taken or to which the
            item should be stowed
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        taken:
          allOf:
            - $ref: '#/components/schemas/TakenStowLineItemTakeFromForCreation'
          description: >-
            Operative data holding information about the stowing progress. **As
            for now stocks will *not* be updated even if the numbers indicate so
            because the stow job feature is still under development.**
        type:
          description: >-
            Define if items should be taken from specific stock or storage
            location. Use type UNREGISTERED if a new item should be booked into
            the system
          enum:
            - STOCK
            - LOCATION
            - UNREGISTERED
          type: string
      required:
        - quantity
        - type
      title: StowLineItemTakeFromForCreation
      type: object
      description: StowLineItemTakeFromForCreation
    StowLineItemTakeFromType:
      description: >-
        Define if items should be taken from specific stock or storage location.
        Use type UNREGISTERED if a new item should be booked into the system.
      enum:
        - STOCK
        - LOCATION
        - UNREGISTERED
      type: string
      xml:
        name: StowLineItemTakeFromType
      title: StowLineItemTakeFromType
    StringEqFilter:
      properties:
        eq:
          maxLength: 256
          type: string
        notEq:
          maxLength: 256
          type: string
      title: StringEqFilter
      type: object
      description: StringEqFilter
    StringFilter:
      properties:
        eq:
          maxLength: 256
          type: string
        in:
          items:
            maxLength: 256
            type: string
          maxItems: 25
          type: array
        notEq:
          maxLength: 256
          type: string
        notIn:
          items:
            maxLength: 256
            type: string
          maxItems: 25
          type: array
      title: StringFilter
      type: object
      description: StringFilter
    StringListExistsFilter:
      properties:
        contains:
          $ref: '#/components/schemas/StringEqFilter'
        exists:
          description: Search all entities which have or do not have this key defined
          type: boolean
      title: StringListExistsFilter
      type: object
      description: StringListExistsFilter
    StringListFilter:
      properties:
        contains:
          $ref: '#/components/schemas/StringEqFilter'
      title: StringListFilter
      type: object
      description: StringListFilter
    StringSearchFilter:
      properties:
        eq:
          maxLength: 256
          type: string
        in:
          items:
            maxLength: 256
            type: string
          maxItems: 25
          type: array
        like:
          description: Search by regex pattern
          maxLength: 256
          type: string
        notEq:
          maxLength: 256
          type: string
        notIn:
          items:
            maxLength: 256
            type: string
          maxItems: 25
          type: array
      title: StringSearchFilter
      type: object
      description: StringSearchFilter
    StringValidation:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/BaseValidation'
      description: Validate input as string.
      properties:
        maxLength:
          type: number
        minLength:
          type: number
      title: StringValidation
      type: object
    StrippedBrands:
      properties:
        brands:
          items:
            $ref: '#/components/schemas/Brand'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedBrands
      description: StrippedBrands
    StrippedCarrier:
      properties:
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        deliveryType:
          description: The delivery type of this carrier
          enum:
            - SAMEDAY
            - DELIVERY
          type: string
        id:
          description: The id of the carrier
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
        key:
          description: >-
            References the KEP. Currently allowed values are DHL_V2, DPD_CH,
            DPD_CH_VCE, ANGEL, GLS, FEDEX, POSTNL, BRING, UPS, POST_NORD,
            DHL_EXPRESS, CUSTOM and to distinct between multiple custom carriers
            one can use CUSTOM_ combined with a unique name.
          example: DHL_V2
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        lifecycle:
          description: The lifecycle of this carrier
          enum:
            - GA
            - BETA
            - ALPHA
          type: string
        name:
          description: >-
            This is the well known name for a supported CEP partner. Can be
            adapted to the clients needs.
          example: DHL
          type: string
        status:
          description: The status of this carrier
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - id
        - key
        - name
        - version
      title: StrippedCarrier
      type: object
      description: StrippedCarrier
    StrippedCarriers:
      properties:
        carriers:
          description: List of carriers
          items:
            $ref: '#/components/schemas/StrippedCarrier'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      title: StrippedCarriers
      type: object
      description: StrippedCarriers
    StrippedCustomServices:
      properties:
        customServices:
          description: List of custom services matching the query
          items:
            $ref: '#/components/schemas/CustomService'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      title: StrippedCustomServices
      type: object
      description: StrippedCustomServices
    StrippedFacilities:
      properties:
        facilities:
          items:
            anyOf:
              - $ref: '#/components/schemas/StrippedManagedFacility'
              - $ref: '#/components/schemas/Supplier'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedFacilities
      description: StrippedFacilities
    StrippedFacilityCustomServiceConnections:
      properties:
        facilityCustomServiceConnections:
          description: List of facility to custom service connections matching the query
          items:
            $ref: '#/components/schemas/FacilityCustomServiceConnection'
          maxItems: 500
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      title: StrippedFacilityCustomServiceConnections
      type: object
      description: StrippedFacilityCustomServiceConnections
    StrippedFilterEntities:
      properties:
        filterEntities:
          items:
            $ref: '#/components/schemas/FilterEntity'
          type: array
        total:
          description: Total number of found filter entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedFilterEntities
      description: StrippedFilterEntities
    StrippedHandoverContainer:
      properties:
        handoverContainer:
          items:
            $ref: '#/components/schemas/HandoverContainer'
          type: array
        total:
          description: total number for the given filter
          example: 42
          type: integer
      required:
        - total
        - handoverContainer
      title: StrippedHandoverContainer
      type: object
      description: StrippedHandoverContainer
    StrippedHandoverjob:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            carrierKey:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo
              type: string
              deprecated: true
            carrierRef:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo
              type: string
              deprecated: true
            channel:
              $ref: '#/components/schemas/HandoverjobChannel'
            facilityRef:
              description: The id of the facility reference.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            fullIdentifier:
              description: An information to identify the recipient
              type: string
            handoverJobParcelInfo:
              $ref: '#/components/schemas/HandoverJobParcelInfo'
            id:
              description: >-
                The id of this handoverjob. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: 95EWrieX09OmeriXIUbb
              type: string
            invoiceAddress:
              $ref: '#/components/schemas/ConsumerAddress'
            loadUnitRefs:
              description: Reference to array of load unit Refs
              items:
                type: string
              type: array
            orderDate:
              description: The date this order was created at the supplying system.
              example: 2020-02-03T08:45:50.525Z
              format: date-time
              type: string
            parcelRef:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo
              example: 2fOge2ZGW54K4TgvDTQw
              type: string
              deprecated: true
            pickJobRef:
              description: >-
                The reference to the pickjob for which the handoverjob is
                assigned to
              example: ca525716-7208-4a63-a2a6-11274eb37f67-0
              type: string
            recipientAddress:
              $ref: '#/components/schemas/ConsumerAddress'
            searchPaths:
              description: This is the search term that was used to find the handover job
              example: R456728546
              items:
                type: string
              minItems: 0
              type: array
            shipmentRef:
              description: >-
                This part of the API is deprecated. For details, see the <a
                href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
                target="_blank">API release lifecycle documentation</a>.<br
                /><br />@deprecated This field is deprecated since 28 November
                2024. Use nested object handoverJobParcelInfo
              example: Esb20gpHBL94X5NdMp3C
              type: string
              deprecated: true
            status:
              $ref: '#/components/schemas/HandoverjobStatus'
            tenantOrderId:
              description: >-
                Field can be used as a reference number in foreign systems, for
                example as a reference to the source system's identifier for
                this order.
              example: R456728546
              type: string
          required:
            - id
            - status
            - facilityRef
            - channel
          type: object
      title: StrippedHandoverjob
      description: StrippedHandoverjob
    StrippedHandoverjobs:
      properties:
        handoverjobs:
          items:
            $ref: '#/components/schemas/StrippedHandoverjob'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedHandoverjobs
      description: StrippedHandoverjobs
    StrippedInboundProcess:
      properties:
        anonymized:
          description: >-
            Indicates the inbound process was anonymized acording to configured
            GDPR retention time.
          type: boolean
        created:
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          type: string
        id:
          type: string
        inboundDate:
          description: >-
            Aggregated dates from sources which advise incoming stock. Currently
            that is "purchaseOrder"
          example: 2026-06-17T12:00:00.000Z
          items:
            format: date-time
            type: string
          type: array
        lastModified:
          format: date-time
          type: string
        onHold:
          description: >-
            Indicates if the inbound process is on hold and will not be
            processed further
          type: boolean
        origin:
          description: >-
            Aggregated origin data from sources which advise incoming stock.
            Currently that is just  "purchaseOrder"
          items:
            $ref: '#/components/schemas/InboundProcessOrigin'
          type: array
        scannableCodes:
          description: >-
            scannableCodes such as barcodes that are relevant in the
            inboundProcess, e.g. , barcode of the delivery note
          items:
            type: string
          type: array
        status:
          enum:
            - OPEN
            - PARTIAL_DELIVERY
            - ON_HOLD
            - CLOSED
          type: string
        tenantInboundProcessId:
          type: string
        version:
          type: number
      required:
        - facilityRef
        - id
        - version
        - created
        - lastModified
        - inboundDate
        - origin
        - anonymized
        - status
        - onHold
        - scannableCodes
      title: StrippedInboundProcess
      type: object
      description: StrippedInboundProcess
    StrippedListing:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            id:
              example: fsfdsf87fsd
              type: string
            status:
              enum:
                - ACTIVE
                - INACTIVE
              type: string
            tenantArticleId:
              description: This is a reference to an article Id
              example: '4711'
              type: string
          required:
            - status
            - facilityId
            - id
            - tenantArticleId
          type: object
      title: StrippedListing
      description: StrippedListing
    StrippedListings:
      properties:
        listings:
          items:
            $ref: '#/components/schemas/StrippedListing'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedListings
      description: StrippedListings
    StrippedManagedFacility:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/Address'
        - properties:
            id:
              type: string
            name:
              description: name of the facility
              example: Köln store
              type: string
            status:
              $ref: '#/components/schemas/FacilityStatus'
            tenantFacilityId:
              description: The id of the facility in the tenants own system
              example: K12345
              type: string
            type:
              $ref: '#/components/schemas/FacilityType'
          required:
            - id
            - status
            - type
          type: object
      title: StrippedManagedFacility
      description: StrippedManagedFacility
    StrippedOidcProvider:
      properties:
        assignedGroups:
          description: The assigned groups of the OIDC provider
          items:
            $ref: '#/components/schemas/AssignedGroup'
          type: array
        clientId:
          description: The client id of the OIDC provider
          type: string
        customParameters:
          description: The custom parameters of the OIDC provider
          items:
            $ref: '#/components/schemas/OidcProviderCustomParameter'
          type: array
        id:
          description: The id of the OIDC provider
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        issuer:
          description: The issuer of the OIDC provider
          type: string
        name:
          description: The name of the OIDC provider
          type: string
        roleManagementMode:
          description: >-
            Determines whether role assignments of this OIDC provider are
            managed by the IDP (IDP_MANAGED, default) or locally in
            fulfillmenttools (IDP_IDENTITY_ONLY). The ADMINISTRATOR role always
            stays IDP-managed.
          enum:
            - IDP_MANAGED
            - IDP_IDENTITY_ONLY
          type: string
        status:
          description: The status of the OIDC provider
          enum:
            - ACTIVE
            - INACTIVE
          type: string
        version:
          description: The version of the OIDC provider
          example: 1
          type: number
      required:
        - name
        - status
        - issuer
        - clientId
        - customParameters
        - assignedGroups
        - id
        - version
      title: StrippedOidcProvider
      type: object
      description: StrippedOidcProvider
    StrippedOrder:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            id:
              description: >-
                The id of this order. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: LGMl2DuvPnfPoSHhYFOm
              type: string
            orderDate:
              description: The date this order was created at the supplying system.
              example: 2020-02-03T08:45:50.525Z
              format: date-time
              type: string
            orderLineItems:
              items:
                properties:
                  quantity:
                    description: quantity of the specific article that has been ordered
                    example: 21
                    format: int64
                    minimum: 1
                    type: integer
                  title:
                    example: Cologne Water
                    type: string
                required:
                  - quantity
                  - title
                type: object
              type: array
            processRef:
              type: string
            status:
              $ref: '#/components/schemas/OrderStatus'
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
          required:
            - id
            - status
            - orderDate
          type: object
      title: StrippedOrder
      description: StrippedOrder
    StrippedOrders:
      properties:
        orders:
          items:
            $ref: '#/components/schemas/StrippedOrder'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedOrders
      description: StrippedOrders
    StrippedPackingSourceContainer:
      additionalProperties: false
      properties:
        codes:
          items:
            description: Codes, that identify the container
            type: string
          minItems: 1
          type: array
        id:
          example: c7467ba8-c28a-4473-8748-a4e54e675e4c
          type: string
        loadUnitRef:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Deprecated: Use previousModuleContainerInfo instead. For load
            units ref see: type: LOAD_UNIT.
          example: 2357914c-d965-421e-b6cf-330501bccaab
          type: string
        previousModuleContainerInfo:
          $ref: '#/components/schemas/PreviousModuleContainerInfo'
      type: object
      title: StrippedPackingSourceContainer
      description: StrippedPackingSourceContainer
    StrippedParcel:
      properties:
        carrierRef:
          description: The reference to the carrier for which the parcel is assigned to
          example: ca525716-7208-4a63-a2a6-11274eb37f67-0
          type: string
        carrierTrackingNumber:
          example: '84168117830018'
          type: string
        parcelRef:
          example: 15EZrieW09OmeriXIUbc
          type: string
        status:
          $ref: '#/components/schemas/ParcelStatus'
      required:
        - parcelRef
        - carrierRef
        - status
      type: object
      title: StrippedParcel
      description: StrippedParcel
    StrippedParcels:
      properties:
        parcels:
          items:
            $ref: '#/components/schemas/StrippedParcel'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedParcels
      description: StrippedParcels
    StrippedPickJob:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            carrierKey:
              example: DPD
              type: string
            facilityRef:
              description: >-
                The id of the facility reference. The given ID has to be present
                in the system.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            id:
              type: string
            orderRef:
              description: >-
                The id of the order that lead to the creation of this pickjob.
                Can be empty / not present when the pickjob was created without
                having an order.
              example: LGMl2DuvPnfPoSHhYFOm
              type: string
            searchPaths:
              items:
                type: string
              minItems: 0
              type: array
            status:
              $ref: '#/components/schemas/PickJobStatus'
            targetTime:
              description: At which time the result is expected.
              example: 2020-02-03T09:45:51.525Z
              format: date-time
              type: string
          required:
            - id
            - status
            - created
            - lastModified
            - version
          type: object
      title: StrippedPickJob
      description: StrippedPickJob
    StrippedPickJobs:
      properties:
        pickjobs:
          items:
            $ref: '#/components/schemas/StrippedPickJob'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedPickJobs
      description: StrippedPickJobs
    StrippedReservation:
      properties:
        id:
          type: string
      required:
        - id
      title: StrippedReservation
      type: object
      description: StrippedReservation
    StrippedShipments:
      properties:
        shipments:
          items:
            $ref: '#/components/schemas/ShipmentWithSearchPath'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: StrippedShipments
      description: StrippedShipments
    StrippedShippingTargetAddress:
      properties:
        country:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        postalCode:
          example: '40764'
          pattern: ^.+
          type: string
      type: object
      title: StrippedShippingTargetAddress
      description: StrippedShippingTargetAddress
    StrippedTags:
      properties:
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
        tags:
          items:
            $ref: '#/components/schemas/Tag'
          type: array
      type: object
      title: StrippedTags
      description: StrippedTags
    Subscription:
      allOf:
        - $ref: '#/components/schemas/SubscriptionForCreation'
      properties:
        created:
          description: >-
            The date this subscription was created at the platform. This value
            is generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        id:
          type: string
      required:
        - id
        - created
      type: object
      title: Subscription
      description: Subscription
    SubscriptionContext:
      description: >-
        Context filter for subscriptions to limit events based on facility
        relationships.
      properties:
        type:
          $ref: '#/components/schemas/SubscriptionContextType'
        values:
          description: Array of facility IDs or facility group names to filter by.
          items:
            type: string
          minItems: 1
          type: array
      required:
        - type
        - values
      title: SubscriptionContext
      type: object
    SubscriptionContextType:
      description: Types of context filters for subscriptions.
      enum:
        - FACILITY
        - FACILITY_GROUP
      title: SubscriptionContextType
      type: string
    SubscriptionForCreation:
      additionalProperties: false
      properties:
        callbackUrl:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Deprecated: Use new 'target' object instead.
          type: string
        contexts:
          description: >-
            Optional context filters to limit which events trigger the
            subscription based on facility relationships. Multiple contexts are
            evaluated with logical AND. FACILITY context can only appear once,
            FACILITY_GROUP contexts can appear multiple times.
          items:
            $ref: '#/components/schemas/SubscriptionContext'
          type: array
        event:
          description: Name of the event in the fulfillmenttools platform.
          type: string
        headers:
          deprecated: true
          description: >-
            This part of the API is deprecated. For details, see the <a
            href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
            target="_blank">API release lifecycle documentation</a>.<br /><br
            />Deprecated: Use new 'target' object instead.
          items:
            $ref: '#/components/schemas/CallbackHeader'
          minItems: 1
          type: array
        name:
          description: Name of the event, this is freely selectable.
          type: string
        target:
          anyOf:
            - $ref: '#/components/schemas/SubscriptionTargetWebhook'
            - $ref: '#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBus'
            - $ref: '#/components/schemas/SubscriptionTargetGoogleCloudPubSub'
      required:
        - name
        - event
      type: object
      title: SubscriptionForCreation
      description: SubscriptionForCreation
    Subscriptions:
      properties:
        subscriptions:
          items:
            $ref: '#/components/schemas/Subscription'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
      title: Subscriptions
      description: Subscriptions
    SubscriptionTargetGoogleCloudPubSub:
      additionalProperties: false
      description: Subscriptions model for a Google Cloud Pub/Sub target.
      properties:
        projectId:
          description: Id of the Google Cloud project.
          minLength: 1
          type: string
        topicId:
          description: Id of the Google Cloud Pub/Sub topic.
          minLength: 1
          type: string
        type:
          $ref: '#/components/schemas/SubscriptionTargetGoogleCloudPubSubEnum'
      required:
        - type
        - projectId
        - topicId
      title: SubscriptionTargetGoogleCloudPubSub
      type: object
    SubscriptionTargetGoogleCloudPubSubEnum:
      description: Type of subscription target Google Cloud Pub/Sub.
      enum:
        - GOOGLE_CLOUD_PUB_SUB
      title: SubscriptionTargetGoogleCloudPubSubEnum
      type: string
    SubscriptionTargetMicrosoftAzureServiceBus:
      additionalProperties: false
      description: Subscriptions model for a Microsoft Azure Service Bus target.
      properties:
        clientId:
          description: >-
            'Application (Client) ID' from the app registration in 'Microsoft
            Entra ID' (formerly 'Azure AD').
          minLength: 1
          type: string
        clientSecret:
          description: Client secret from the used Azure application.
          minLength: 1
          type: string
        namespace:
          description: The Azure Service Bus namespace.
          minLength: 1
          type: string
        queueOrTopicName:
          description: Name of the queue or topic in the Service Bus namespace.
          minLength: 1
          type: string
        tenantId:
          description: >-
            'Directory (Tenant) ID' from the app registration in 'Microsoft
            Entra ID' (formerly 'Azure AD').
          minLength: 1
          type: string
        type:
          $ref: '#/components/schemas/SubscriptionTargetMicrosoftAzureServiceBusEnum'
      required:
        - type
        - tenantId
        - clientId
        - clientSecret
        - namespace
        - queueOrTopicName
      title: SubscriptionTargetMicrosoftAzureServiceBus
      type: object
    SubscriptionTargetMicrosoftAzureServiceBusEnum:
      description: Type of subscription target Microsoft Azure Service Bus.
      enum:
        - MICROSOFT_AZURE_SERVICE_BUS
      title: SubscriptionTargetMicrosoftAzureServiceBusEnum
      type: string
    SubscriptionTargetWebhook:
      additionalProperties: false
      description: Subscriptions model for a Webhook target.
      properties:
        callbackUrl:
          type: string
        headers:
          items:
            $ref: '#/components/schemas/CallbackHeader'
          minItems: 1
          type: array
        type:
          $ref: '#/components/schemas/SubscriptionTargetWebhookEnum'
      required:
        - type
        - callbackUrl
      title: SubscriptionTargetWebhook
      type: object
    SubscriptionTargetWebhookEnum:
      description: Type of subscription target webhook.
      enum:
        - WEBHOOK
      title: SubscriptionTargetWebhookEnum
      type: string
    Substitute:
      properties:
        attributes:
          items:
            $ref: '#/components/schemas/SubstituteAttributeItem'
          maxItems: 40
          type: array
        imageUrl:
          type: string
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        measurementValidation:
          $ref: '#/components/schemas/MeasurementValidation'
        priority:
          description: >-
            This field allows you to rank substitutes against each other. The
            lowest number is the most preferrable substitute.
          minimum: 0
          type: number
        scannableCodes:
          items:
            description: Strings, that identify the substitute article
            type: string
          maxItems: 500
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: gram
          type: string
        tenantArticleId:
          type: string
        title:
          type: string
      required:
        - title
        - tenantArticleId
      type: object
      xml:
        name: Substitute
      title: Substitute
      description: Substitute
    SubstituteAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      title: SubstituteAttributeItem
      description: SubstituteAttributeItem
    SubstituteLineItem:
      properties:
        article:
          $ref: '#/components/schemas/SubstituteLineItemArticle'
        globalLineItemId:
          description: >-
            This id is used to identify if this line item is related to the line
            item of other operational entities.
          type: string
        id:
          type: string
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        measurementValidation:
          $ref: '#/components/schemas/MeasurementValidation'
        partialStockLocations:
          items:
            $ref: '#/components/schemas/SubstituteLineItemPartialStockLocation'
          type: array
        picked:
          description: The amount of articles that were picked for this pickline.
          example: 20
          format: int64
          minimum: 0
          type: integer
        pickedAt:
          description: Date when the line has been picked.
          example: 2024-02-03T08:45:51.525Z
          format: date-time
          type: string
        priority:
          description: >-
            This field allows you to rank substitutes against each other. The
            lowest number is the most preferrable substitute.
          minimum: 0
          type: number
        quantity:
          description: >-
            quantity of the specific article that needs to be picked to
            substitute the item
          example: 21
          format: int64
          minimum: 1
          type: integer
        refused:
          items:
            $ref: '#/components/schemas/RefusedItem'
          type: array
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        secondaryMeasurementUnitKey:
          description: >-
            Identifier for items unit of measurement. E.g. measurementUnitKey is
            pieces and secondaryMeasurementUnitKey is gram
          example: gram
          type: string
        secondaryPicked:
          description: The secondary amount of articles that were picked for this pickline.
          example: 20
          format: int64
          minimum: 0
          type: integer
        secondaryQuantity:
          description: >-
            secondary quantity of this item, E.g. quantity is the count and
            secondaryQuantity is the weight
          example: 200
          format: int64
          minimum: 1
          type: integer
      required:
        - article
        - id
        - quantity
      type: object
      title: SubstituteLineItem
      description: SubstituteLineItem
    SubstituteLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              maxItems: 40
              type: array
          type: object
      xml:
        name: SubstituteLineItemArticle
      title: SubstituteLineItemArticle
      description: SubstituteLineItemArticle
    SubstituteLineItemForUpsert:
      properties:
        id:
          description: >-
            The id of the substitute line item to update. If none is passed, a
            new substitute line item will be created.
          type: string
        picked:
          description: The amount of articles that were picked for this pickline.
          example: 20
          format: int64
          minimum: 0
          type: integer
        pickedAt:
          description: Date when the line has been picked.
          example: 2024-02-03T08:45:51.525Z
          format: date-time
          type: string
        quantity:
          description: >-
            quantity of the specific article that needs to be picked to
            substitute the item
          example: 21
          format: int64
          minimum: 1
          type: integer
        secondaryPicked:
          description: The secondary amount of articles that were picked for this pickline.
          example: 20
          format: int64
          minimum: 0
          type: integer
        secondaryQuantity:
          description: >-
            secondary quantity of this item, E.g. quantity is the count and
            secondaryQuantity is the weight
          example: 21
          format: int64
          minimum: 1
          type: integer
        tenantArticleId:
          description: TenantArticleId of the substitute article
          type: string
      required:
        - tenantArticleId
        - quantity
      type: object
      title: SubstituteLineItemForUpsert
      description: SubstituteLineItemForUpsert
    SubstituteLineItemPartialStockLocation:
      properties:
        location:
          $ref: '#/components/schemas/Location'
        picked:
          example: 21
          format: int64
          minimum: 0
          type: number
        quantity:
          example: 21
          format: int64
          minimum: 0
          type: number
        ratingScore:
          type: number
        sequenceScore:
          type: number
        stockProperties:
          anyOf:
            - $ref: '#/components/schemas/PickingStockPropertyPreset'
            - $ref: '#/components/schemas/PickingStockProperty'
        stockRef:
          type: string
        tenantPartialStockId:
          type: string
        zoneName:
          type: string
      required:
        - location
        - quantity
      type: object
      title: SubstituteLineItemPartialStockLocation
      description: SubstituteLineItemPartialStockLocation
    Substitutes:
      allOf:
        - $ref: '#/components/schemas/Entity'
        - $ref: '#/components/schemas/SubstitutesForUpsert'
      required:
        - tenantArticleId
        - substitutes
      type: object
      xml:
        name: Substitutes
      title: Substitutes
      description: Substitutes
    SubstitutesForUpsert:
      properties:
        substitutes:
          items:
            $ref: '#/components/schemas/Substitute'
          type: array
        tenantArticleId:
          type: string
        version:
          description: >-
            Version field is used in the optimistic locking process. If the
            Substitute is for the tenantArticleId is not set yet, this field is
            ignored.
          example: 1
          type: number
      required:
        - substitutes
        - version
        - tenantArticleId
      type: object
      xml:
        name: SubstitutesForUpsert
      title: SubstitutesForUpsert
      description: SubstitutesForUpsert
    SubstitutionConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      description: Substitution Configuration
      properties:
        active:
          default: true
          description: Toggle for substitution articles.
          example: false
          type: boolean
      required:
        - active
      title: SubstitutionConfiguration
      type: object
    Supplier:
      allOf:
        - $ref: '#/components/schemas/Facility'
        - $ref: '#/components/schemas/SupplierForCreation'
      properties:
        address:
          $ref: '#/components/schemas/SupplierAddress'
      type: object
      xml:
        name: Supplier
      title: Supplier
      description: Supplier
    SupplierAddress:
      allOf:
        - $ref: '#/components/schemas/SupplierAddressForCreation'
        - properties:
            resolvedTimeZone:
              $ref: '#/components/schemas/TimeZone'
          type: object
      type: object
      title: SupplierAddress
      description: SupplierAddress
    SupplierAddressEmailAddress:
      properties:
        recipient:
          description: >-
            Human readable information who is the recipient for emails sent to
            this address.
          example: >-
            'Mailinglist reaching all the employees', 'Marc Fulton, Manager',
            etc.
          type: string
        value:
          format: email
          type: string
      required:
        - value
      type: object
      title: SupplierAddressEmailAddress
      description: SupplierAddressEmailAddress
    SupplierAddressForCreation:
      properties:
        additionalAddressInfo:
          example: 'to care of: Mrs. Müller'
          type: string
        city:
          example: Langenfeld
          pattern: ^.+$
          type: string
        companyName:
          example: Speedy Boxales Ltd.
          type: string
        country:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the address. These attributes cannot
            be used within fulfillment processes, but it could be useful to have
            the informations carried here.
          type: object
        emailAddresses:
          items:
            $ref: '#/components/schemas/SupplierAddressEmailAddress'
          type: array
        houseNumber:
          example: 42a
          pattern: ^.+$
          type: string
        phoneNumbers:
          items:
            $ref: '#/components/schemas/SupplierAddressPhoneNumber'
          type: array
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        province:
          example: NRW
          pattern: ^.+$
          type: string
        resolvedCoordinates:
          $ref: '#/components/schemas/Coordinates'
        resolvedTimeZone:
          $ref: '#/components/schemas/TimeZoneForCreation'
          description: >-
            User-specified time zone in identifier format (e.g.,
            "America/Los_Angeles"). Used to determine local time. Relevant only
            if the country spans multiple time zones; otherwise, the time zone
            is automatically determined from the country or via Google if
            unspecified.
          example: America/Los_Angeles
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      required:
        - country
        - companyName
      type: object
      title: SupplierAddressForCreation
      description: SupplierAddressForCreation
    SupplierAddressPhoneNumber:
      properties:
        customAttributes:
          description: >-
            Attributes that can be added to the phonenumber. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        label:
          description: >-
            Can be used to give a description for the number, like "private",
            "business number", etc.
          type: string
        type:
          enum:
            - MOBILE
            - PHONE
          type: string
        value:
          description: The number itself. We do not enforce any format (yet).
          type: string
      required:
        - value
        - type
      type: object
      title: SupplierAddressPhoneNumber
      description: SupplierAddressPhoneNumber
    SupplierForCreation:
      allOf:
        - $ref: '#/components/schemas/FacilityForCreation'
      properties:
        address:
          $ref: '#/components/schemas/SupplierAddressForCreation'
      type: object
      xml:
        name: SupplierForCreation
      title: SupplierForCreation
      description: SupplierForCreation
    SupplierForModification:
      additionalProperties: false
      properties:
        address:
          allOf:
            - $ref: '#/components/schemas/SupplierAddressForCreation'
          nullable: true
          type: object
        customAttributes:
          description: >-
            Attributes that can be added to the facility. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          nullable: true
          type: object
        name:
          example: Hamburg NW2
          type: string
        status:
          $ref: '#/components/schemas/FacilityStatus'
        tenantFacilityId:
          description: The id of the facility in the tenants own system
          example: K12345
          nullable: true
          type: string
        type:
          $ref: '#/components/schemas/FacilityType'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          nullable: true
          type: array
      required:
        - type
        - version
      type: object
      title: SupplierForModification
      description: SupplierForModification
    SupplierForReplacement:
      additionalProperties: false
      properties:
        address:
          $ref: '#/components/schemas/SupplierAddressForCreation'
        customAttributes:
          description: >-
            Attributes that can be added to the facility. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        name:
          example: Hamburg NW2
          type: string
        status:
          $ref: '#/components/schemas/FacilityStatus'
        tenantFacilityId:
          description: The id of the facility in the tenants own system
          example: K12345
          type: string
        type:
          $ref: '#/components/schemas/FacilityType'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          minItems: 1
          type: array
      required:
        - version
        - name
        - status
        - type
      type: object
      discriminator:
        propertyName: type
      xml:
        name: SupplierForReplacement
      title: SupplierForReplacement
      description: SupplierForReplacement
    SupplyingFacilityConfiguration:
      anyOf:
        - required:
            - facilityRef
        - required:
            - tenantFacilityId
      properties:
        deliveryEvents:
          items:
            $ref: '#/components/schemas/DeliveryEvent'
          maxItems: 500
          type: array
        facilityRef:
          description: ID of the facility.
          type: string
        tenantFacilityId:
          description: Reference to the facility.
          type: string
      required:
        - deliveryEvents
      title: SupplyingFacilityConfiguration
      description: SupplyingFacilityConfiguration
    SupportActivationRequest:
      properties:
        durationHours:
          description: Duration in hours (1-3)
          example: 2
          type: number
        name:
          description: The action to perform
          enum:
            - ACTIVATE_SUPPORT_MODE
          type: string
        reason:
          description: Reason for activating support mode
          example: Debugging customer order fulfillment issue
          type: string
        supportTicket:
          description: Optional support ticket reference
          example: ZENDESK-12345
          type: string
      required:
        - name
        - reason
        - durationHours
      title: SupportActivationRequest
      type: object
      description: SupportActivationRequest
    SupportDeactivationRequest:
      properties:
        name:
          description: The action to perform
          enum:
            - DEACTIVATE_SUPPORT_MODE
          type: string
      required:
        - name
      title: SupportDeactivationRequest
      type: object
      description: SupportDeactivationRequest
    SupportedEvent:
      properties:
        description:
          type: string
        event:
          type: string
      type: object
      title: SupportedEvent
      description: SupportedEvent
    SupportedEvents:
      properties:
        supportedEvents:
          items:
            $ref: '#/components/schemas/SupportedEvent'
          type: array
      type: object
      title: SupportedEvents
      description: SupportedEvents
    SupportedFilterEntityTypesEnum:
      description: Entity types supported as filter entities
      enum:
        - STICKER
      example: STICKER
      type: string
      title: SupportedFilterEntityTypesEnum
    SupportedLocale:
      description: >-
        This part of the API is in Beta status. For details, see the <a
        href="https://docs.fulfillmenttools.com/documentation/apis/api-versioning-and-lifecycle#lifecycle-overview"
        target="_blank">API release lifecycle documentation</a>.<br /><br />ISO
        3166 conform country code and ISO 639-1 conform language code (de_DE,
        en_US, ch_FR, etc.)
      enum:
        - de_DE
        - en_US
        - pl_PL
        - ru_RU
        - nl_NL
        - fr_FR
        - it_IT
        - nb_NO
        - es_ES
        - cs_CZ
        - sk_SK
        - pt_PT
        - sl_SI
        - ro_RO
        - bg_BG
        - hr_HR
        - hu_HU
        - tr_TR
      example: de_DE
      type: string
      title: SupportedLocale
      x-badges:
        - color: orange
          label: BETA
    SupportedLocales:
      items:
        $ref: '#/components/schemas/SupportedLocale'
      type: array
      title: SupportedLocales
      description: SupportedLocales
    SupportExtensionRequest:
      properties:
        additionalHours:
          description: Additional hours to extend (1-3, max total 5 hours)
          example: 2
          type: number
        name:
          description: The action to perform
          enum:
            - EXTEND_SUPPORT_SESSION
          type: string
        reason:
          description: Reason for extension
          example: Additional time needed to complete investigation
          type: string
      required:
        - name
        - additionalHours
        - reason
      title: SupportExtensionRequest
      type: object
      description: SupportExtensionRequest
    SupportStatusRequest:
      properties:
        name:
          description: The action to perform
          enum:
            - CHECK_SUPPORT_STATUS
          type: string
      required:
        - name
      title: SupportStatusRequest
      type: object
      description: SupportStatusRequest
    Tag:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagForCreation'
      properties:
        id:
          type: string
      required:
        - id
      xml:
        name: Tag
      title: Tag
      description: Tag
    TagConfiguration:
      properties:
        offeredDocumentsByDefault:
          description: >-
            This configuration is a fallback and applies only if none of the
            entries in offeredDocumentsPerTag can be applied
          items:
            $ref: '#/components/schemas/OfferedDocument'
          maxItems: 500
          type: array
        offeredDocumentsPerTag:
          description: >-
            All entries with a match in their matchingValues will be combined
            when determining what documents belong to an entity
          items:
            $ref: '#/components/schemas/OfferedDocumentPerTag'
          maxItems: 500
          type: array
      required:
        - offeredDocumentsPerTag
        - offeredDocumentsByDefault
      title: TagConfiguration
      description: TagConfiguration
    TagForCreation:
      additionalProperties: false
      properties:
        allowedValues:
          items:
            type: string
          minItems: 1
          type: array
        id:
          type: string
      required:
        - id
        - allowedValues
      title: TagForCreation
      description: TagForCreation
    TagPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
        tags:
          items:
            $ref: '#/components/schemas/Tag'
          type: array
      required:
        - pageInfo
        - tags
      title: TagPaginatedResult
      type: object
      description: TagPaginatedResult
    TagPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/AddAllowedValueToTag'
          minItems: 1
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
        - actions
      type: object
      xml:
        name: TagPatchActions
      title: TagPatchActions
      description: TagPatchActions
    TagReference:
      properties:
        id:
          type: string
        value:
          type: string
      required:
        - value
        - id
      title: TagReference
      description: TagReference
    TagScanningConfiguration:
      additionalProperties: false
      properties:
        offeredScanningRuleByTag:
          items:
            $ref: '#/components/schemas/OfferedScanningRuleByTag'
          type: array
      title: TagScanningConfiguration
      description: TagScanningConfiguration
    TagSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/TagSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/TagSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: TagSearchPayload
      type: object
      description: TagSearchPayload
    TagSearchQuery:
      properties:
        allowedValues:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by allowedValues
        and:
          items:
            $ref: '#/components/schemas/TagSearchQuery'
          maxItems: 500
          type: array
        id:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        or:
          items:
            $ref: '#/components/schemas/TagSearchQuery'
          maxItems: 500
          type: array
      title: TagSearchQuery
      type: object
      description: TagSearchQuery
    TagSort:
      properties:
        id:
          enum:
            - ASC
            - DESC
          type: string
      title: TagSort
      type: object
      description: TagSort
    TakenStowLineItemTakeFrom:
      properties:
        takenAt:
          description: Time and date on which the item was taken
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        takenQuantity:
          description: Quantity that was taken
          type: number
        takenStockRef:
          description: |-
            Specifies the stock from which the goods will be taken. 
             Exception: If stowTo.type is "UNREGISTERED", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
      required:
        - takenQuantity
        - takenStockRef
      title: TakenStowLineItemTakeFrom
      type: object
      description: TakenStowLineItemTakeFrom
    TakenStowLineItemTakeFromForCreation:
      properties:
        takenAt:
          description: Time and date on which the item was taken
          example: 2026-06-17T12:00:00.000Z
          format: date-time
          type: string
        takenQuantity:
          description: Quantity that was taken
          type: number
        takenStockRef:
          description: |-
            Specifies the stock from which the goods will be taken. 
             Exception: If stowTo.type is "UNREGISTERED", this field may be null. If a stock is specified, its quantity will be reduced regardless of the type.
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          nullable: true
          type: string
      required:
        - takenQuantity
        - takenStockRef
      title: TakenStowLineItemTakeFromForCreation
      type: object
      description: TakenStowLineItemTakeFromForCreation
    TakeOverPickJobConfiguration:
      properties:
        active:
          default: false
          description: Enable or disable pick job takeover
          type: boolean
      required:
        - active
      type: object
      title: TakeOverPickJobConfiguration
      description: TakeOverPickJobConfiguration
    TakeOverPickRunActionEnum:
      enum:
        - TAKE_OVER_PICK_RUN
      type: string
      title: TakeOverPickRunActionEnum
      description: TakeOverPickRunActionEnum
    TakeOverPickRunActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/TakeOverPickRunActionEnum'
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
      title: TakeOverPickRunActionParameter
      type: object
      description: TakeOverPickRunActionParameter
    TakeOverPickRunConfiguration:
      properties:
        active:
          default: false
          description: Enable or disable pick run takeover
          type: boolean
      required:
        - active
      type: object
      title: TakeOverPickRunConfiguration
      description: TakeOverPickRunConfiguration
    TargetAddress:
      allOf:
        - $ref: '#/components/schemas/ConsumerAddress'
        - properties:
            facilityRef:
              description: >-
                The id of the facility reference. The given ID has to be present
                in the system.
              example: Esb20gpHBL94X5NdMp3C
              type: string
            tenantFacilityId:
              description: >-
                The tenantFacilityId of the facility. The given ID has to be
                present in the system.
              example: Esb20gpHBL94X5NdMp3C
              type: string
          type: object
      type: object
      title: TargetAddress
      description: TargetAddress
    TenantConfiguration:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clearName:
          type: string
        domainStatusMappingConfiguration:
          $ref: '#/components/schemas/DomainStatusMappingConfiguration'
      required:
        - clearName
      type: object
      title: TenantConfiguration
      description: TenantConfiguration
    TenantConfigurationForUpsert:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clearName:
          type: string
        domainStatusMappingConfiguration:
          $ref: '#/components/schemas/DomainStatusMappingConfiguration'
        version:
          type: number
      required:
        - clearName
        - version
      type: object
      title: TenantConfigurationForUpsert
      description: TenantConfigurationForUpsert
    TenantConnectorConfiguration:
      additionalProperties: false
      properties:
        apiUrl:
          example: https://some-name.api.fulfillmenttools.com
          type: string
        app:
          $ref: '#/components/schemas/ConnectAppTypeEnum'
        firebaseAppId:
          example: 1:180217824890:android:f1fbf11eb8a613cbda9ee4
          type: string
        firebaseAppIdDebug:
          example: 1:180217824890:android:c861c7b58d938e05da9ee4
          type: string
        firebaseProjectId:
          example: some-name
          type: string
        firebaseWebApiKey:
          example: GTasGTHJZ_ku_gaad_P2A4KRDQW_MM_-AS-Lglk
          type: string
      required:
        - app
        - firebaseProjectId
        - apiUrl
        - firebaseWebApiKey
        - firebaseAppId
        - firebaseAppIdDebug
      title: TenantConnectorConfiguration
      description: TenantConnectorConfiguration
    TenantConnectorConfigurations:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        connectApps:
          description: All possible apps
          items:
            $ref: '#/components/schemas/TenantConnectorConfiguration'
          minItems: 1
          type: array
      required:
        - version
        - connectApps
      type: object
      title: TenantConnectorConfigurations
      description: TenantConnectorConfigurations
    TenantFacilityIdSelector:
      properties:
        tenantFacilityId:
          description: Resolves a facility by its tenantFacilityId.
          example: MY_FACILITY_ID
          minLength: 1
          type: string
      required:
        - tenantFacilityId
      title: TenantFacilityIdSelector
      type: object
      description: TenantFacilityIdSelector
    TenantSourceId:
      additionalProperties: false
      properties:
        tenantSourceId:
          type: string
      required:
        - tenantSourceId
      type: object
      title: TenantSourceId
      description: TenantSourceId
    ThresholdPriceValue:
      properties:
        priceRange:
          allOf:
            - $ref: '#/components/schemas/PriceRange'
          description: Price range for which this threshold applies
        priority:
          description: >-
            The lower the value the higher is the priority, e.g. priority 1 is
            higher than priority 10. The priority is used when comparing
            multiple carriers.
          minimum: 1
          type: number
      required:
        - priority
        - priceRange
      title: ThresholdPriceValue
      type: object
      description: ThresholdPriceValue
    TimeRange:
      properties:
        capacity:
          minimum: 0
          type: number
        end:
          $ref: '#/components/schemas/TimeStamp'
        start:
          $ref: '#/components/schemas/TimeStamp'
      required:
        - start
        - end
      type: object
      title: TimeRange
      description: TimeRange
    TimeStamp:
      properties:
        hour:
          maximum: 23
          minimum: 0
          type: number
        minute:
          maximum: 59
          minimum: 0
          type: number
      required:
        - hour
        - minute
      type: object
      title: TimeStamp
      description: TimeStamp
    TimeTriggeredConfigContextType:
      enum:
        - FACILITY
        - FACILITY_GROUP
      type: string
      title: TimeTriggeredConfigContextType
      description: TimeTriggeredConfigContextType
    TimeTriggeredConfigurationContext:
      additionalProperties: false
      properties:
        priority:
          minimum: 0
          type: number
        timeTriggered:
          $ref: '#/components/schemas/RoutingStrategyRerouteTimeTriggeredConfig'
        type:
          $ref: '#/components/schemas/TimeTriggeredConfigContextType'
        values:
          description: >-
            The id of the context values. For example, if the type is FACILITY,
            then the values are the ids of the facilities.
          items:
            format: uuid
            type: string
          maxItems: 500
          type: array
      required:
        - priority
        - type
        - values
        - timeTriggered
      type: object
      title: TimeTriggeredConfigurationContext
      description: TimeTriggeredConfigurationContext
    TimeTriggeredRerouteFailedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/TimeTriggeredRerouteFailedWebHookEventPayload'
      required:
        - payload
      type: object
      title: TimeTriggeredRerouteFailedWebHookEvent
      description: TimeTriggeredRerouteFailedWebHookEvent
    TimeTriggeredRerouteFailedWebHookEventPayload:
      properties:
        facilityData:
          properties:
            facilityRef:
              type: string
            name:
              type: string
            timeZone:
              type: string
          required:
            - name
            - facilityRef
            - timeZone
        pickJobData:
          properties:
            created:
              example: 2020-02-03T08:45:51.525Z
              format: date-time
              type: string
            pickJobRef:
              type: string
            shortId:
              type: string
            tenantOrderId:
              type: string
          required:
            - pickJobRef
            - tenantOrderId
            - shortId
            - created
        processRef:
          type: string
        rerouteDate:
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
      required:
        - processRef
        - pickJobData
        - facilityData
        - rerouteDate
      title: TimeTriggeredRerouteFailedWebHookEventPayload
      description: TimeTriggeredRerouteFailedWebHookEventPayload
    TimeZone:
      description: Timezone for information retrieved e.g. by the Google Maps API
      properties:
        offsetInSeconds:
          description: >-
            offset in seconds to standard time. Does not account for daylight
            saving time.
          example: 28800
          type: number
        source:
          description: source of the timezone information
          example: Google Maps API
          type: string
        timeZoneId:
          description: official id of the timezone
          example: America/Los_Angeles
          type: string
        timeZoneName:
          description: descriptive name of the timezone
          example: Pacific Standard Time
          type: string
      required:
        - timeZoneId
        - timeZoneName
        - offsetInSeconds
      type: object
      title: TimeZone
    TimeZoneForCreation:
      description: Self-provided timezone for determining the local time of a facility
      properties:
        timeZoneId:
          description: official id of the timezone
          example: America/Los_Angeles
          type: string
      required:
        - timeZoneId
      type: object
      title: TimeZoneForCreation
    ToolkitAllowedEntities:
      description: |-
        The entities that can be compared by the toolkit fence or rating
          * `ORDER`
          * `FACILITY`
          * `CARRIERCONNECTION`
          * `LISTING`
          * `ORDERING_FACILITY` - left side only
          * `ORDERING_FACILITY_GROUPS` - left side only
      enum:
        - ORDER
        - FACILITY
        - CARRIERCONNECTION
        - LISTING
        - ORDERING_FACILITY
        - ORDERING_FACILITY_GROUPS
      type: string
      xml:
        name: ToolkitAllowedEntities
      title: ToolkitAllowedEntities
    ToolkitComparisonDecisionDetail:
      allOf:
        - $ref: '#/components/schemas/BaseDecisionDetail'
      description: Toolkit Comparison Decision Detail.
      properties:
        description:
          type: string
        explanation:
          $ref: >-
            #/components/schemas/ToolkitRuleComparePropertiesOperatorResultExplanation
        predicateConnector:
          $ref: '#/components/schemas/ToolkitPredicateConnector'
        predicates:
          items:
            $ref: '#/components/schemas/ToolKitComparisonDetails'
          type: array
      required:
        - predicates
        - predicateConnector
        - description
      title: ToolkitComparisonDecisionDetail
    ToolKitComparisonDetails:
      properties:
        evaluationResult:
          type: boolean
        leftPart:
          $ref: '#/components/schemas/ToolKitComparisonPart'
        predicate:
          $ref: '#/components/schemas/ToolkitComparisonPredicate'
        rightPart:
          $ref: '#/components/schemas/ToolKitComparisonPart'
      required:
        - leftPart
        - rightPart
        - evaluationResult
        - predicate
      title: ToolKitComparisonDetails
      description: ToolKitComparisonDetails
    ToolKitComparisonPart:
      properties:
        originalValue:
          items:
            type: string
          type: array
        transformedValue:
          items:
            type: string
          type: array
      required:
        - originalValue
        - transformedValue
      title: ToolKitComparisonPart
      description: ToolKitComparisonPart
    ToolkitComparisonPredicate:
      description: >-
        The predicate for a Toolkit V2 Fence that defines how conditions are
        constructed
      properties:
        entityOperator:
          $ref: '#/components/schemas/ToolkitRuleComparisonOperatorType'
        leftEntity:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          description: >-
            The entity that is used for the right side of the comparison -
            overrides the entity2 property
        leftPropertyPath:
          minLength: 1
          type: string
        leftTransformation:
          $ref: '#/components/schemas/ToolkitTransformationType'
        leftTransformationArgs:
          items:
            oneOf:
              - type: string
              - type: number
              - type: boolean
          maxItems: 100
          type: array
        rightEntity:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          description: >-
            The entity that is used for the right side of the comparison -
            overrides the entity1 property
        rightPropertyPath:
          minLength: 1
          type: string
        rightTransformation:
          $ref: '#/components/schemas/ToolkitTransformationType'
        rightTransformationArgs:
          items:
            oneOf:
              - type: string
              - type: number
              - type: boolean
          maxItems: 100
          type: array
      required:
        - rightPropertyPath
        - leftPropertyPath
        - entityOperator
        - leftEntity
        - rightEntity
      type: object
      xml:
        name: ToolkitComparisonPredicate
      title: ToolkitComparisonPredicate
    ToolkitComparisonRule:
      description: >-
        The rule, comparing the left and right path values, that will be
        evaluated applying a RuleOperator
      properties:
        evaluationScope:
          $ref: '#/components/schemas/ToolkitRuleScope'
        predicateConnector:
          $ref: '#/components/schemas/ToolkitPredicateConnector'
        predicates:
          items:
            $ref: '#/components/schemas/ToolkitComparisonPredicate'
          maxItems: 100
          minItems: 1
          type: array
      required:
        - predicates
        - evaluationScope
      type: object
      xml:
        name: ToolkitRule
      title: ToolkitComparisonRule
    ToolkitDecisionDetail:
      allOf:
        - $ref: '#/components/schemas/BaseDecisionDetail'
      description: Toolkit Decision Detail.
      properties:
        comparisonOperator:
          $ref: '#/components/schemas/ToolkitRuleComparisonOperatorType'
        description:
          type: string
        explanation:
          $ref: '#/components/schemas/ToolkitRuleOperatorResultExplanation'
        leftPredicatesDetail:
          $ref: '#/components/schemas/ToolkitPredicatesDecisionDetail'
        leftSideEvaluation:
          type: boolean
        rightPredicatesDetail:
          $ref: '#/components/schemas/ToolkitPredicatesDecisionDetail'
        rightSideEvaluation:
          type: boolean
      required:
        - decisionType
        - leftSideEvaluation
        - description
      title: ToolkitDecisionDetail
    ToolkitEntityOperatorType:
      description: The possible operator types that can be used on given entities
      enum:
        - VALUE_EQUALS
        - VALUE_NOT_EQUALS
        - ANY_VALUE_EQUALS
        - ANY_VALUE_GREATER_EQUALS
        - ANY_VALUE_GREATER_THAN
        - ANY_VALUE_LESS_EQUALS
        - ANY_VALUE_LESS_THAN
        - ANY_VALUE_CONTAINS
        - ANY_VALUE_NOT_CONTAINS
        - EVERY_VALUE_EQUALS
        - EVERY_VALUE_GREATER_EQUALS
        - EVERY_VALUE_GREATER_THAN
        - EVERY_VALUE_LESS_EQUALS
        - EVERY_VALUE_LESS_THAN
        - EVERY_VALUE_CONTAINS
        - EVERY_VALUE_NOT_CONTAINS
        - NO_VALUE_EQUALS
        - NO_VALUE_GREATER_EQUALS
        - NO_VALUE_GREATER_THAN
        - NO_VALUE_LESS_EQUALS
        - NO_VALUE_LESS_THAN
        - NO_VALUE_CONTAINS
        - NO_VALUE_NOT_CONTAINS
        - VALUE_CONTAINS
        - VALUE_NOT_CONTAINS
        - GREATER_THAN
        - GREATER_EQUALS
        - LESS_THAN
        - LESS_EQUALS
      type: string
      xml:
        name: ToolkitEntityOperatorType
      title: ToolkitEntityOperatorType
    ToolkitFence:
      allOf:
        - $ref: '#/components/schemas/ToolkitFenceForModification'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          description: The id of the toolkit fence
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
      required:
        - id
      type: object
      xml:
        name: ToolkitFence
      title: ToolkitFence
      description: ToolkitFence
    ToolkitFenceForCreation:
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          default: false
          description: Indicates whether this fence is active or not.
          type: boolean
        comparisonRule:
          $ref: '#/components/schemas/ToolkitComparisonRule'
        description:
          description: The description of this fence.
          example: Some text that describes what the fence does.
          type: string
        entity1:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        entity2:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        name:
          description: The name of the fence.
          example: CustomFence
          type: string
        order:
          description: Order in which this fence is executed
          example: 1
          type: integer
        rule:
          $ref: '#/components/schemas/ToolkitRule'
      required:
        - name
        - nameLocalized
        - active
        - order
      type: object
      xml:
        name: ToolkitFenceForCreation
      title: ToolkitFenceForCreation
      description: ToolkitFenceForCreation
    ToolkitFenceForModification:
      allOf:
        - $ref: '#/components/schemas/ToolkitFenceForCreation'
      properties:
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      xml:
        name: ToolkitFenceForModification
      title: ToolkitFenceForModification
      description: ToolkitFenceForModification
    ToolkitFencesTransporter:
      properties:
        fences:
          items:
            $ref: '#/components/schemas/ToolkitFence'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      required:
        - fences
        - total
      type: object
      xml:
        name: ToolkitFenceTransporter
      title: ToolkitFencesTransporter
      description: ToolkitFencesTransporter
    ToolkitOperatorType:
      description: |-
        Type of operator used for a toolkit fence or rating:
          * `TAG_EQUALS`- the entity2 should have a tag with the same id as the entity1 and the value is dynamically matched
          * `VALUE_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does match
          * `VALUE_NOT_EQUALS`- compares the tag of entity1 with the tag of entity2 attending to the configured rule and returns true if it does not match
      enum:
        - TAG_EQUALS
        - VALUE_EQUALS
        - VALUE_NOT_EQUALS
      type: string
      xml:
        name: ToolkitOperatorType
      title: ToolkitOperatorType
    ToolkitPredicate:
      description: >-
        The predicate for a Toolkit V2 Fence that defines how conditions are
        constructed
      properties:
        entity:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
        entityOperator:
          $ref: '#/components/schemas/ToolkitEntityOperatorType'
        expectedValue:
          oneOf:
            - type: string
            - type: number
            - type: boolean
        propertyPath:
          minLength: 1
          type: string
        transformation:
          $ref: '#/components/schemas/ToolkitTransformationType'
        transformationArgs:
          items:
            oneOf:
              - type: string
              - type: number
              - type: boolean
          maxItems: 100
          type: array
      required:
        - propertyPath
        - entityOperator
        - entity
      type: object
      xml:
        name: ToolkitPredicate
      title: ToolkitPredicate
    ToolkitPredicateConnector:
      description: The allowed operators for connecting multiple predicates
      enum:
        - OR
        - AND
      type: string
      xml:
        name: ToolkitPredicateConnector
      title: ToolkitPredicateConnector
    ToolkitPredicateDecisionDetail:
      properties:
        evaluationResult:
          type: boolean
        originalValue:
          items:
            type: string
          type: array
        predicate:
          $ref: '#/components/schemas/ToolkitPredicate'
        transformedValue:
          items:
            type: string
          type: array
      required:
        - originalValue
        - transformedValue
        - evaluationResult
        - predicate
      title: ToolkitPredicateDecisionDetail
      description: ToolkitPredicateDecisionDetail
    ToolkitPredicatesDecisionDetail:
      properties:
        connector:
          $ref: '#/components/schemas/ToolkitPredicateConnector'
        predicates:
          items:
            $ref: '#/components/schemas/ToolkitPredicateDecisionDetail'
          type: array
      required:
        - connector
        - predicates
      title: ToolkitPredicatesDecisionDetail
      description: ToolkitPredicatesDecisionDetail
    ToolkitRating:
      allOf:
        - $ref: '#/components/schemas/ToolkitRatingForModification'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          description: The id of the toolkit rating
          example: LGMl2DuvPnfPoSHhYFOm
          type: string
      required:
        - id
      type: object
      xml:
        name: ToolkitRating
      title: ToolkitRating
      description: ToolkitRating
    ToolkitRatingForCreation:
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        active:
          default: false
          description: Indicates whether this fence is active or not
          type: boolean
        comparisonRule:
          $ref: '#/components/schemas/ToolkitComparisonRule'
        description:
          description: The description of this rating
          example: Some text that describes what the rating does.
          type: string
        entity1:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        entity2:
          $ref: '#/components/schemas/ToolkitAllowedEntities'
          deprecated: true
          description: >-
            This field is obsolete, was replaced by the entity fields at
            predicate level.
        maxPenalty:
          description: The maximum penalty this rating can have
          example: 100
          type: integer
        name:
          description: The name of the rating
          example: CustomRating
          type: string
        rule:
          $ref: '#/components/schemas/ToolkitRule'
      required:
        - name
        - nameLocalized
        - active
        - maxPenalty
      type: object
      xml:
        name: ToolkitRatingForCreation
      title: ToolkitRatingForCreation
      description: ToolkitRatingForCreation
    ToolkitRatingForModification:
      allOf:
        - $ref: '#/components/schemas/ToolkitRatingForCreation'
      properties:
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      xml:
        name: ToolkitRatingForModification
      title: ToolkitRatingForModification
      description: ToolkitRatingForModification
    ToolkitRatingTransporter:
      properties:
        ratings:
          items:
            $ref: '#/components/schemas/ToolkitRating'
          type: array
        total:
          description: Total number of entities found for this query
          example: 42
          type: integer
      required:
        - ratings
        - total
      type: object
      xml:
        name: ToolkitRatingTransporter
      title: ToolkitRatingTransporter
      description: ToolkitRatingTransporter
    ToolkitRule:
      description: >-
        The rule, containing the left predicates and the right predicates, that
        will be evaluated applying a RuleOperator
      properties:
        evaluationScope:
          $ref: '#/components/schemas/ToolkitRuleScope'
        leftPart:
          $ref: '#/components/schemas/ToolkitRulePart'
        operator:
          $ref: '#/components/schemas/ToolkitRuleOperatorType'
        rightPart:
          $ref: '#/components/schemas/ToolkitRulePart'
      required:
        - operator
        - leftPart
        - rightPart
        - evaluationScope
      type: object
      xml:
        name: ToolkitRule
      title: ToolkitRule
    ToolkitRuleComparePropertiesOperatorResultExplanation:
      enum:
        - ALL_PREDICATES_MET
        - NOT_ALL_PREDICATES_MET
        - SKIPPED_BECAUSE_OF_ERROR
      title: ToolkitRuleComparePropertiesOperatorResultExplanation
      description: ToolkitRuleComparePropertiesOperatorResultExplanation
    ToolkitRuleComparisonOperatorType:
      description: >-
        The type of the rule operator applied to the results of evaluating the
        left predicates and the right predicates
      enum:
        - NO_MATCHES
        - ALL_MATCHES
        - LEFT_CONTAINS_RIGHT
        - RIGHT_CONTAINS_LEFT
      type: string
      xml:
        name: ToolkitTransformationType
      title: ToolkitRuleComparisonOperatorType
    ToolkitRuleOperatorResultExplanation:
      enum:
        - SKIPPED
        - BOTH_CONDITIONS_MET
        - ONLY_FIRST_CONDITION_MET
        - ONLY_SECOND_CONDITION_MET
        - SKIPPED_BECAUSE_OF_ERROR
      title: ToolkitRuleOperatorResultExplanation
      description: ToolkitRuleOperatorResultExplanation
    ToolkitRuleOperatorType:
      description: >-
        The type of the rule operator applied to the results of evaluating the
        left predicates and the right predicates
      enum:
        - EQUALS
      type: string
      xml:
        name: ToolkitTransformationType
      title: ToolkitRuleOperatorType
    ToolkitRulePart:
      additionalProperties: false
      description: >-
        One half of the rule, containing either the left or right predicates and
        booleanOperator.
      properties:
        predicateConnector:
          $ref: '#/components/schemas/ToolkitPredicateConnector'
        predicates:
          items:
            $ref: '#/components/schemas/ToolkitPredicate'
          maxItems: 100
          minItems: 1
          type: array
      required:
        - predicates
      type: object
      xml:
        name: ToolkitRulePart
      title: ToolkitRulePart
    ToolkitRuleScope:
      enum:
        - WHOLE_ENTITY
        - LINE_ITEM
      type: string
      xml:
        name: ToolkitRuleScope
      title: ToolkitRuleScope
      description: ToolkitRuleScope
    ToolkitTransformationType:
      description: >-
        The transformations available to apply on the entity property value
        before a predicate is evaluated
      enum:
        - SUBSTRING
        - COUNT
        - SUM
        - LAST
      type: string
      xml:
        name: ToolkitTransformationType
      title: ToolkitTransformationType
    TrackingInformation:
      properties:
        carrierRef:
          description: Reference to the connected carrier
          example: 283554a4-1ba5-459b-9bf2-59bc9c68f60e
          minLength: 1
          type: string
        carrierStatus:
          additionalProperties: true
          anyOf:
            - type: string
            - type: object
          description: Status of the latest tracking information event status.
          example:
            code: SOME_CODE
            status: SOME_VALUE
        carrierStatusSet:
          description: Creation timestamp of the latest tracking information event status.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        created:
          description: Creation date of this tracking information
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        facilityRef:
          description: >-
            Reference to the connected facility ref via the connected shipping
            information
          example: f7fcd0a1-d269-42d9-8322-ba8f354ca6a0
          type: string
        id:
          description: Unique identifier of this tracking information
          example: d7058a3c-e57d-45dc-b024-e1725bb09541
          type: string
        labelRef:
          description: Reference to the connected label
          example: 3b06b80c-55ae-4e0e-af1d-8843d901e9ed
          minLength: 1
          type: string
        labelUrl:
          description: The URL to the label for this tracking information.
          example: https://www.example.com/label.pdf
          minLength: 1
          type: string
        lastModified:
          description: Last modification date of this tracking information
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        shippingInformationRef:
          description: Reference to the connected shipping information
          example: 9d88d014-5627-4f01-96fe-80c5621d268d
          minLength: 1
          type: string
        status:
          description: >-
            Status of the tracking information entity. Will either be set by the
            workflow or calculated from the event history.
          enum:
            - CREATED
            - IN_PROGRESS
            - FINISHED
            - CANCELLED
            - OBSOLETE
          example: IN_PROGRESS
          type: string
        trackingHistory:
          description: >-
            The tracking history of the tracking information. Most recent one is
            defined by the statusSet timestamp, then the internal id.
          example:
            - carrierStatus: CA_DELIVERY
              carrierStatusSet: 2020-02-03T08:45:50.525Z
              id: 066960e1-630c-4b13-b0b5-58d537190107
              status: DELIVERED
              statusSet: 2020-02-03T08:45:50.525Z
          items:
            $ref: '#/components/schemas/TrackingInformationTrackingEvent'
          maxItems: 100
          minItems: 1
          type: array
        trackingNumber:
          description: Tracking number of the connected label
          example: '000123456'
          minLength: 1
          type: string
        trackingStatus:
          description: >-
            Latest tracking information event status. Based on the found
            tracking event history.
          enum:
            - REGISTERED
            - ERROR
            - PICKED_UP
            - IN_DELIVERY
            - DELIVERED
            - DELIVERED_TO_RECIPIENT
            - DELIVERED_TO_NEIGHBOUR
            - DELIVERED_TO_PICK_UP_STATION
            - NOT_PICKED_UP
            - RETURN_TO_SENDER
            - LOST
            - DESTROYED
            - CANCELLED
            - UNKNOWN
          example: DELIVERED
          type: string
        trackingStatusSet:
          description: Creation timestamp of the latest tracking information event.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        trackingUrl:
          description: Url to the tracking page of the given carrier and tracking number
          example: https://www.example.com/tracking:000123456
          minLength: 1
          type: string
        type:
          description: Type of this tracking information
          enum:
            - SEND
            - RETURN
          example: RETURN
          type: string
        version:
          description: Version number of this tracking information
          example: 42
          type: integer
      required:
        - type
        - carrierRef
        - shippingInformationRef
        - trackingNumber
        - trackingUrl
        - labelUrl
        - trackingHistory
        - id
        - created
        - lastModified
        - version
        - status
        - trackingStatus
        - trackingStatusSet
        - carrierStatus
        - facilityRef
      title: TrackingInformation
      type: object
      description: TrackingInformation
    TrackingInformationAddTrackingEventActionParameter:
      properties:
        name:
          description: Name of this action
          example: ADD_TRACKING_EVENTS
          type: string
        trackingEvents:
          description: Events to add to the tracking information
          example:
            - carrierStatus: CA_DELIVERY
              carrierStatusSet: 2020-02-03T08:45:50.525Z
              status: DELIVERED
              statusSet: 2020-02-03T08:45:50.525Z
          items:
            $ref: '#/components/schemas/TrackingInformationTrackingEventForCreation'
          maxItems: 20
          minItems: 1
          type: array
        version:
          description: Version of the tracking information to call the action upon
          example: 2
          minimum: 0
          type: integer
      required:
        - name
        - version
        - trackingEvents
      title: TrackingInformationAddTrackingEventActionParameter
      type: object
      description: TrackingInformationAddTrackingEventActionParameter
    TrackingInformationForCreation:
      properties:
        carrierRef:
          description: Reference to the connected carrier
          example: 283554a4-1ba5-459b-9bf2-59bc9c68f60e
          minLength: 1
          type: string
        labelRef:
          description: Reference to the connected label
          example: 3b06b80c-55ae-4e0e-af1d-8843d901e9ed
          minLength: 1
          type: string
        labelUrl:
          description: The URL to the label for this tracking information.
          example: https://www.example.com/label.pdf
          minLength: 1
          type: string
        shippingInformationRef:
          description: Reference to the connected shipping information
          example: 9d88d014-5627-4f01-96fe-80c5621d268d
          minLength: 1
          type: string
        trackingHistory:
          description: >-
            The tracking history of the tracking information. Most recent one is
            defined by the statusSet timestamp, then the internal id.
          example:
            - carrierStatus: CA_DELIVERY
              carrierStatusSet: 2020-02-03T08:45:50.525Z
              status: DELIVERED
              statusSet: 2020-02-03T08:45:50.525Z
          items:
            $ref: '#/components/schemas/TrackingInformationTrackingEventForCreation'
          maxItems: 100
          minItems: 1
          type: array
        trackingNumber:
          description: Tracking number of the connected label
          example: '000123456'
          minLength: 1
          type: string
        trackingUrl:
          description: Url to the tracking page of the given carrier and tracking number
          example: https://www.example.com/tracking:000123456
          minLength: 1
          type: string
        type:
          description: Type of this tracking information
          enum:
            - SEND
            - RETURN
          example: RETURN
          type: string
      required:
        - type
        - carrierRef
        - shippingInformationRef
        - trackingNumber
        - trackingUrl
        - labelUrl
        - trackingHistory
      title: TrackingInformationForCreation
      type: object
      description: TrackingInformationForCreation
    TrackingInformationListResponse:
      properties:
        totalCount:
          description: >-
            Total number of found tracking information for the given search
            parameters
          example: 42
          type: integer
        trackingInformation:
          items:
            $ref: '#/components/schemas/TrackingInformation'
          type: array
      required:
        - trackingInformation
      title: TrackingInformationListResponse
      type: object
      description: TrackingInformationListResponse
    TrackingInformationPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
        trackingInformations:
          items:
            $ref: '#/components/schemas/TrackingInformation'
          type: array
      required:
        - pageInfo
        - trackingInformations
      title: TrackingInformationPaginatedResult
      type: object
      description: TrackingInformationPaginatedResult
    TrackingInformationRemoveTrackingEventsParameter:
      properties:
        name:
          description: Name of this action
          example: REMOVE_TRACKING_EVENTS
          type: string
        trackingEventIds:
          description: >-
            Ids of the tracking events that should be removed from the tracking
            information
          example:
            - fa21fdf3-9618-4697-ba2c-1f39a3a78b80
          items:
            type: string
          maxItems: 20
          minItems: 1
          type: array
        version:
          description: Version of the tracking information to call the action upon
          example: 2
          minimum: 0
          type: integer
      required:
        - name
        - version
        - trackingEventIds
      title: TrackingInformationRemoveTrackingEventsParameter
      type: object
      description: TrackingInformationRemoveTrackingEventsParameter
    TrackingInformationSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/TrackingInformationSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/TrackingInformationSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: TrackingInformationSearchPayload
      type: object
      description: TrackingInformationSearchPayload
    TrackingInformationSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/TrackingInformationSearchQuery'
          maxItems: 500
          type: array
        carrierRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by carrierRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        created:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: >-
            Search entries by created. Applying a narrow and well-considered
            filter value is strongly recommended, as it can greatly improve
            response times, especially when working with large datasets.
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        labelRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by labelRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        or:
          items:
            $ref: '#/components/schemas/TrackingInformationSearchQuery'
          maxItems: 500
          type: array
        shippingInformationRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by shippingInformationRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        trackingNumber:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by trackingNumber
      title: TrackingInformationSearchQuery
      type: object
      description: TrackingInformationSearchQuery
    TrackingInformationSort:
      properties:
        created:
          enum:
            - ASC
            - DESC
          type: string
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: TrackingInformationSort
      type: object
      description: TrackingInformationSort
    TrackingInformationTrackingEvent:
      properties:
        carrierStatus:
          additionalProperties: true
          anyOf:
            - type: string
            - type: object
          description: Status from the carrier before mapping to the internal status
          example:
            code: SOME_CODE
            status: SOME_VALUE
        carrierStatusSet:
          description: Creation timestamp
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        id:
          description: Unique identifier of this tracking history
          example: 890b857f-8d66-4ec0-91ba-1cc19f2944f6
          type: string
        status:
          description: Internal Status of this Tracking Information Event
          enum:
            - REGISTERED
            - ERROR
            - PICKED_UP
            - IN_DELIVERY
            - DELIVERED
            - DELIVERED_TO_RECIPIENT
            - DELIVERED_TO_NEIGHBOUR
            - DELIVERED_TO_PICK_UP_STATION
            - NOT_PICKED_UP
            - RETURN_TO_SENDER
            - LOST
            - DESTROYED
            - CANCELLED
            - UNKNOWN
          example: DELIVERED
          type: string
        statusSet:
          description: Creation timestamp
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - status
        - statusSet
        - carrierStatus
        - id
      title: TrackingInformationTrackingEvent
      type: object
      description: TrackingInformationTrackingEvent
    TrackingInformationTrackingEventForCreation:
      properties:
        carrierStatus:
          additionalProperties: true
          anyOf:
            - type: string
            - type: object
          description: Status from the carrier before mapping to the internal status
          example:
            code: SOME_CODE
            status: SOME_VALUE
        carrierStatusSet:
          description: Creation timestamp
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        status:
          description: Internal Status of this Tracking Information Event
          enum:
            - REGISTERED
            - ERROR
            - PICKED_UP
            - IN_DELIVERY
            - DELIVERED
            - DELIVERED_TO_RECIPIENT
            - DELIVERED_TO_NEIGHBOUR
            - DELIVERED_TO_PICK_UP_STATION
            - NOT_PICKED_UP
            - RETURN_TO_SENDER
            - LOST
            - DESTROYED
            - CANCELLED
            - UNKNOWN
          example: DELIVERED
          type: string
        statusSet:
          description: Creation timestamp
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
      required:
        - status
        - statusSet
        - carrierStatus
      title: TrackingInformationTrackingEventForCreation
      type: object
      description: TrackingInformationTrackingEventForCreation
    TrackingStatus:
      description: The state of the KEP
      enum:
        - registered
        - picked_up
        - delivered
        - not_delivered
        - transit
        - exception
        - out_for_delivery
        - destroyed
        - unknown
        - canceled
        - awaits_pickup_by_receiver
        - delayed
        - notification
      title: TrackingStatus
      type: string
    Transfer:
      properties:
        transferId:
          type: string
        transferType:
          enum:
            - SUPPLIER
            - RECEIVER
          type: string
      required:
        - transferId
        - transferType
      title: Transfer
      description: Transfer
    TransferTimeLine:
      properties:
        calculationStartPoint:
          description: >-
            The date and time from which all time-related calculations for the
            corresponding items are based.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        earliestPickingStart:
          description: >-
            The earliest date and time when picking for the corresponding items
            can begin.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        earliestPossibleDeliveryTime:
          description: >-
            The earliest date at which the corresponding items can be delivered
            to the recipient.
          example: 2020-02-03T00:00:00.000Z
          format: date-time
          type: string
        latestPickingStart:
          description: >-
            The latest date and time when picking for the corresponding items
            can begin.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        targetTime:
          description: >-
            The desired date and time by which the corresponding items should be
            fulfilled.
          example: 2020-02-03T08:45:50.525Z
          format: date-time
          type: string
        usedTransitTimeInDays:
          description: The raw amount of transit days used for timeline calculation
          example: 3
          minimum: 0
          type: integer
      required:
        - calculationStartPoint
        - earliestPickingStart
        - latestPickingStart
        - targetTime
      type: object
      xml:
        name: TransferTimeLine
      title: TransferTimeLine
      description: TransferTimeLine
    TransitTimeConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        calculationStrategy:
          enum:
            - EARLIEST
            - LATEST
          type: string
        id:
          type: string
      required:
        - id
        - calculationStrategy
      type: object
      title: TransitTimeConfiguration
      description: TransitTimeConfiguration
    TransitTimeConfigurationForUpsert:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        calculationStrategy:
          enum:
            - EARLIEST
            - LATEST
          type: string
      required:
        - calculationStrategy
      type: object
      title: TransitTimeConfigurationForUpsert
      description: TransitTimeConfigurationForUpsert
    TwoManHandlingDetails:
      properties:
        dimensions:
          $ref: '#/components/schemas/PackagingUnitDetailDimensions'
        maxItemQuantity:
          description: The maximum number of items that can fit in the packagingUnit.
          type: number
        maxVolume:
          description: The maximum volume in cubicle millimeters of the packagingUnit.
          type: number
        maxWeight:
          description: The maximum weight in grams that the packagingUnit can hold.
          type: number
        packagingPricingDetails:
          $ref: '#/components/schemas/PackagingPricingDetails'
        type:
          description: The type of the packagingUnit.
          enum:
            - PALLET
            - TWO_MAN_HANDLING
            - PARCEL
            - BULKY_GOODS
          type: string
        volumeBufferInPercent:
          description: The volume buffer in percent for the packagingUnit.
          type: number
      required:
        - type
        - dimensions
        - maxWeight
        - packagingPricingDetails
      title: TwoManHandlingDetails
      type: object
      description: TwoManHandlingDetails
    UBSendCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: UBSendCarrierConfiguration
      type: object
      description: UBSendCarrierConfiguration
    UpcomingTimeTriggeredRerouteWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/UpcomingTimeTriggeredRerouteWebHookEventPayload'
      required:
        - payload
      type: object
      title: UpcomingTimeTriggeredRerouteWebHookEvent
      description: UpcomingTimeTriggeredRerouteWebHookEvent
    UpcomingTimeTriggeredRerouteWebHookEventPayload:
      properties:
        facilityData:
          properties:
            facilityRef:
              type: string
            name:
              type: string
            timeZone:
              type: string
          required:
            - name
            - facilityRef
            - timeZone
        pickJobData:
          properties:
            created:
              example: 2020-02-03T08:45:51.525Z
              format: date-time
              type: string
            pickJobRef:
              type: string
            shortId:
              type: string
            tenantOrderId:
              type: string
          required:
            - pickJobRef
            - tenantOrderId
            - shortId
            - created
        processRef:
          type: string
        rerouteDate:
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
      required:
        - processRef
        - pickJobData
        - facilityData
        - rerouteDate
      title: UpcomingTimeTriggeredRerouteWebHookEventPayload
      description: UpcomingTimeTriggeredRerouteWebHookEventPayload
    UpdateChannelByIdAction:
      properties:
        channel:
          oneOf:
            - $ref: '#/components/schemas/EmailNotificationChannel'
            - $ref: '#/components/schemas/ClientNotificationChannel'
        name:
          enum:
            - UPDATE_CHANNEL
          type: string
        version:
          type: number
      required:
        - name
        - channel
        - version
      title: UpdateChannelByIdAction
      type: object
      description: UpdateChannelByIdAction
    UpdateFacilityCoordinatesActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractFacilityActionsParameter'
      description: Update facility Coordinates.
      properties:
        coordinates:
          $ref: '#/components/schemas/Coordinates'
        name:
          enum:
            - UPDATE_FACILITY_COORDINATES
          type: string
      required:
        - name
        - coordinates
        - version
      title: UpdateFacilityCoordinatesActionParameter
    UpdateGdprCleanupDateAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'UpdateGdprCleanupDateAction' to update the GDPR
                cleanup date of a process.
              enum:
                - UpdateGdprCleanupDateAction
              type: string
            gdprCleanupDate:
              description: >-
                The date when the process and all connected entities should be
                cleaned up / anonymized.
              format: date
              type: string
          required:
            - action
            - gdprCleanupDate
          type: object
      description: Action to set the GDPR cleanup date of a process.
      title: UpdateGdprCleanupDateAction
      xml:
        name: UpdateGdprCleanupDateAction
    UpdateGdprCleanupDateActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractProcessActionsParameter'
      description: Action to set the GDPR cleanup date of a process.
      properties:
        gdprCleanupDate:
          description: >-
            The date when the process and all connected entities should be
            cleaned up / anonymized.
          format: date
          type: string
        name:
          enum:
            - UPDATE_GDPR_CLEANUP_DATE
          type: string
      required:
        - name
        - version
        - gdprCleanupDate
      title: UpdateGdprCleanupDateActionParameter
    UpdateHandoverLineItemRecordableAttributesActionEnum:
      enum:
        - UPDATE_HANDOVER_LINE_ITEM_RECORDABLE_ATTRIBUTES
      type: string
      title: UpdateHandoverLineItemRecordableAttributesActionEnum
      description: UpdateHandoverLineItemRecordableAttributesActionEnum
    UpdateHandoverLineItemRecordableAttributesActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: >-
            #/components/schemas/UpdateHandoverLineItemRecordableAttributesActionEnum
        recordableAttributeUpdates:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - recordableAttributeUpdates
      title: UpdateHandoverLineItemRecordableAttributesActionParameter
      type: object
      description: UpdateHandoverLineItemRecordableAttributesActionParameter
    UpdateLineItemOnPackingTargetContainer:
      additionalProperties: false
      description: Action to a update a line item of a packing target container.
      properties:
        action:
          description: >-
            Use UpdateLineItemOnPackingTargetContainer to change a line item on
            an existing packing container
          enum:
            - UpdateLineItemOnPackingTargetContainer
          type: string
        lineItem:
          $ref: '#/components/schemas/PackingTargetContainerLineItem'
      required:
        - action
        - lineItem
      title: UpdateLineItemOnPackingTargetContainer
      type: object
      xml:
        name: UpdateLineItemOnPackingTargetContainer
    UpdatePackingTargetContainerLineItemAction:
      additionalProperties: false
      description: Action to update a packing target container of a line item.
      properties:
        name:
          $ref: '#/components/schemas/UpdatePackingTargetContainerLineItemEnum'
        payload:
          additionalProperties: false
          properties:
            lineItem:
              $ref: '#/components/schemas/PackingTargetContainerLineItem'
          required:
            - lineItem
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - version
        - payload
        - name
      title: UpdatePackingTargetContainerLineItemAction
      type: object
    UpdatePackingTargetContainerLineItemEnum:
      enum:
        - UpdateLineItem
      type: string
      title: UpdatePackingTargetContainerLineItemEnum
      description: UpdatePackingTargetContainerLineItemEnum
    UpdatePackingTargetContainerLineItemRecordableAttributes:
      additionalProperties: false
      description: >-
        Action to a update the recordable attributes of the line items of a
        packing target container.
      properties:
        action:
          description: >-
            Use this action to update the recordable attributes of the line
            items of a packing target container
          enum:
            - UpdatePackingTargetContainerLineItemRecordableAttributes
          type: string
        recordableAttributeUpdates:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          type: array
      required:
        - action
        - recordableAttributeUpdates
      title: UpdatePackingTargetContainerLineItemRecordableAttributes
      type: object
      xml:
        name: UpdatePackingTargetContainerLineItemRecordableAttributes
    UpdatePackingTargetContainerStorageLocation:
      additionalProperties: false
      description: Action to update the storageLocationRef of a packing target container.
      properties:
        action:
          description: >-
            Use this action to update the storageLocationRef of a packing target
            container
          enum:
            - UpdatePackingTargetContainerStorageLocation
          type: string
        storageLocationRef:
          description: >-
            Reference to the location where the packing target container is
            located.
          example: 019e16d1-b503-798a-96a0-6868613c9e36
          type: string
        version:
          description: >-
            The version of the packing target container to be used in optimistic
            locking mechanisms.
          example: 42
          type: integer
      required:
        - action
        - version
        - storageLocationRef
      title: UpdatePackingTargetContainerStorageLocation
      type: object
      xml:
        name: UpdatePackingTargetContainerStorageLocation
    UpdatePackLineItemRecordableAttributesActionEnum:
      enum:
        - UPDATE_PACK_LINE_ITEM_RECORDABLE_ATTRIBUTES
      type: string
      title: UpdatePackLineItemRecordableAttributesActionEnum
      description: UpdatePackLineItemRecordableAttributesActionEnum
    UpdatePackLineItemRecordableAttributesActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: >-
            #/components/schemas/UpdatePackLineItemRecordableAttributesActionEnum
        recordableAttributeUpdates:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - recordableAttributeUpdates
      title: UpdatePackLineItemRecordableAttributesActionParameter
      type: object
      description: UpdatePackLineItemRecordableAttributesActionParameter
    UpdateParcelItemRecordableAttributesActionEnum:
      enum:
        - UPDATE_PARCEL_ITEM_RECORDABLE_ATTRIBUTES
      type: string
      title: UpdateParcelItemRecordableAttributesActionEnum
      description: UpdateParcelItemRecordableAttributesActionEnum
    UpdateParcelItemRecordableAttributesActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/UpdateParcelItemRecordableAttributesActionEnum'
        recordableAttributeUpdates:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - recordableAttributeUpdates
      title: UpdateParcelItemRecordableAttributesActionParameter
      type: object
      description: UpdateParcelItemRecordableAttributesActionParameter
    UpdatePickLineItemRecordableAttributesActionEnum:
      enum:
        - UPDATE_PICK_LINE_ITEM_RECORDABLE_ATTRIBUTES
      type: string
      title: UpdatePickLineItemRecordableAttributesActionEnum
      description: UpdatePickLineItemRecordableAttributesActionEnum
    UpdatePickLineItemRecordableAttributesActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: >-
            #/components/schemas/UpdatePickLineItemRecordableAttributesActionEnum
        recordableAttributeUpdates:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - recordableAttributeUpdates
      title: UpdatePickLineItemRecordableAttributesActionParameter
      type: object
      description: UpdatePickLineItemRecordableAttributesActionParameter
    UpdateProcessDeletionDateActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractProcessActionsParameter'
      description: Action to set the deletion date date of a process.
      properties:
        deletionDate:
          description: The date when the process must be deleted.
          format: date
          type: string
        name:
          enum:
            - UPDATE_PROCESS_DELETION_DATE
          type: string
      required:
        - name
        - version
        - deletionDate
      title: UpdateProcessDeletionDateActionParameter
    UpdateRefuseReasonParameter:
      additionalProperties: false
      properties:
        availableRefuseReasonForUpdate:
          $ref: '#/components/schemas/AvailableRefuseReasonForUpdate'
        handoverConfigurationVersion:
          type: number
      required:
        - handoverConfigurationVersion
        - availableRefuseReasonForUpdate
      type: object
      title: UpdateRefuseReasonParameter
      description: UpdateRefuseReasonParameter
    UpdateServiceDataAvailableLineItemsActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS'
          enum:
            - UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS
          example: UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS
          type: string
        serviceDataAvailableLineItemsUpdates:
          description: availableLineItem Updates
          example: 2026-06-17T12:00:00.000Z
          items:
            $ref: '#/components/schemas/ServiceDataAvailableLineItemForUpdate'
          maxItems: 50
          minItems: 1
          type: array
        serviceDataVersion:
          description: Version of the service data
          example: 1
          minimum: 0
          type: integer
      required:
        - name
        - serviceDataAvailableLineItemsUpdates
        - serviceDataVersion
      title: UpdateServiceDataAvailableLineItemsActionParameter
      type: object
      description: UpdateServiceDataAvailableLineItemsActionParameter
    UpdateServiceJobLineItemRecordableAttributesActionParameter:
      properties:
        name:
          description: >-
            Name of the action to perform, must be
            'UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES'
          enum:
            - UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES
          example: UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES
          type: string
        recordableAttributeUpdates:
          example: 2026-06-17T12:00:00.000Z
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          maxItems: 50
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          minimum: 0
          type: integer
      required:
        - name
        - version
        - recordableAttributeUpdates
      title: UpdateServiceJobLineItemRecordableAttributesActionParameter
      type: object
      description: UpdateServiceJobLineItemRecordableAttributesActionParameter
    UpdateShipmentLineItemRecordableAttributesActionEnum:
      enum:
        - UPDATE_SHIPMENT_LINE_ITEM_RECORDABLE_ATTRIBUTES
      type: string
      title: UpdateShipmentLineItemRecordableAttributesActionEnum
      description: UpdateShipmentLineItemRecordableAttributesActionEnum
    UpdateShipmentLineItemRecordableAttributesActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: >-
            #/components/schemas/UpdateShipmentLineItemRecordableAttributesActionEnum
        recordableAttributeUpdates:
          items:
            $ref: '#/components/schemas/RecordableAttributeForUpdate'
          type: array
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - name
        - version
        - recordableAttributeUpdates
      title: UpdateShipmentLineItemRecordableAttributesActionParameter
      type: object
      description: UpdateShipmentLineItemRecordableAttributesActionParameter
    User:
      properties:
        assignedFacilities:
          deprecated: true
          description: 'Deprecated: Find all relevant information in assignedRoles instead'
          items:
            $ref: '#/components/schemas/UserAssignedFacility'
          type: array
        assignedRoles:
          description: The assigned roles of a user
          items:
            $ref: '#/components/schemas/AssignedRoles'
          type: array
        authenticationProvider:
          allOf:
            - $ref: '#/components/schemas/AuthenticationProvider'
          description: The authentication provider of the user
        authenticationProviderType:
          $ref: '#/components/schemas/SupportedLocale'
        created:
          description: Creation date of the user
          format: date-time
          type: string
        customAttributes:
          description: The custom attributes of the user
          nullable: true
          type: object
        customClaims:
          allOf:
            - $ref: '#/components/schemas/CustomClaims'
          deprecated: true
          description: 'Deprecated: Find all relevant information in assignedRoles instead'
        email:
          description: The email of the user
          example: john.doe@example.com
          type: string
        facilityLimitations:
          description: >-
            Facilities where at least one role of the user has access to. Not
            present if the user has at least one role which is unrestricted
          items:
            type: string
          type: array
        firstname:
          description: The first name of the user
          example: John
          type: string
        id:
          description: The id of the user
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastLogin:
          description: The last login timestamp of the user
          format: date-time
          type: string
        lastModified:
          description: Last modification date of the user
          format: date-time
          type: string
        lastname:
          description: The last name of the user
          example: Doe
          type: string
        locale:
          $ref: '#/components/schemas/SupportedLocale'
        username:
          description: The username of the user
          example: johndoe
          type: string
        version:
          description: Version of the user
          example: 1
          type: number
      required:
        - firstname
        - lastname
        - username
        - id
        - authenticationProvider
        - version
        - assignedRoles
      title: User
      type: object
      description: User
    UserActionEnum:
      description: The type of action to perform
      enum:
        - ModifyUser
      title: UserActionEnum
      type: string
    UserAssignedFacilitiesFilter:
      properties:
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
      title: UserAssignedFacilitiesFilter
      type: object
      description: UserAssignedFacilitiesFilter
    UserAssignedFacilitiesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/UserAssignedFacilitiesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: UserAssignedFacilitiesListFilter
      type: object
      description: UserAssignedFacilitiesListFilter
    UserAssignedFacility:
      properties:
        assignedZones:
          description: The assigned zones of the user
          items:
            $ref: '#/components/schemas/UserAssignedZone'
          type: array
        facilityRef:
          description: The id of the assigned facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: The id of the assigned facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - facilityRef
        - id
      title: UserAssignedFacility
      type: object
      description: UserAssignedFacility
    UserAssignedFacilityForCreation:
      properties:
        assignedZones:
          description: The assigned zones of the user
          items:
            $ref: '#/components/schemas/UserAssignedZone'
          type: array
        facilityRef:
          description: The id of the assigned facility
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - facilityRef
      title: UserAssignedFacilityForCreation
      type: object
      description: UserAssignedFacilityForCreation
    UserAssignedRolesContextContextTypesEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - FACILITY
            - FACILITY_GROUP
            - ROLE
            - USER_ROLE
            - ZONE
          type: string
        in:
          description: Search by type
          items:
            enum:
              - FACILITY
              - FACILITY_GROUP
              - ROLE
              - USER_ROLE
              - ZONE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - FACILITY
            - FACILITY_GROUP
            - ROLE
            - USER_ROLE
            - ZONE
          type: string
      title: UserAssignedRolesContextContextTypesEnumFilter
      type: object
      description: UserAssignedRolesContextContextTypesEnumFilter
    UserAssignedRolesContextFilter:
      properties:
        type:
          allOf:
            - $ref: >-
                #/components/schemas/UserAssignedRolesContextContextTypesEnumFilter
          description: Search by type
        values:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by values
      title: UserAssignedRolesContextFilter
      type: object
      description: UserAssignedRolesContextFilter
    UserAssignedRolesContextLimitationsContextTypesEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - FACILITY
            - FACILITY_GROUP
            - ROLE
            - USER_ROLE
            - ZONE
          type: string
        in:
          description: Search by type
          items:
            enum:
              - FACILITY
              - FACILITY_GROUP
              - ROLE
              - USER_ROLE
              - ZONE
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - FACILITY
            - FACILITY_GROUP
            - ROLE
            - USER_ROLE
            - ZONE
          type: string
      title: UserAssignedRolesContextLimitationsContextTypesEnumFilter
      type: object
      description: UserAssignedRolesContextLimitationsContextTypesEnumFilter
    UserAssignedRolesContextLimitationsFilter:
      properties:
        type:
          allOf:
            - $ref: >-
                #/components/schemas/UserAssignedRolesContextLimitationsContextTypesEnumFilter
          description: Search by type
        values:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by values
      title: UserAssignedRolesContextLimitationsFilter
      type: object
      description: UserAssignedRolesContextLimitationsFilter
    UserAssignedRolesContextLimitationsListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/UserAssignedRolesContextLimitationsFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: UserAssignedRolesContextLimitationsListFilter
      type: object
      description: UserAssignedRolesContextLimitationsListFilter
    UserAssignedRolesContextListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/UserAssignedRolesContextFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: UserAssignedRolesContextListFilter
      type: object
      description: UserAssignedRolesContextListFilter
    UserAssignedRolesFilter:
      properties:
        context:
          allOf:
            - $ref: '#/components/schemas/UserAssignedRolesContextListFilter'
          description: Nested list search by context
        contextLimitations:
          allOf:
            - $ref: >-
                #/components/schemas/UserAssignedRolesContextLimitationsListFilter
          deprecated: true
          description: 'Deprecated: Use context field instead'
        ref:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by ref
      title: UserAssignedRolesFilter
      type: object
      description: UserAssignedRolesFilter
    UserAssignedRolesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/UserAssignedRolesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: UserAssignedRolesListFilter
      type: object
      description: UserAssignedRolesListFilter
    UserAssignedRolesSort:
      properties:
        ref:
          enum:
            - ASC
            - DESC
          type: string
      title: UserAssignedRolesSort
      type: object
      description: UserAssignedRolesSort
    UserAssignedZone:
      properties:
        zoneRef:
          description: The id of the assigned zone
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
      required:
        - zoneRef
      title: UserAssignedZone
      type: object
      description: UserAssignedZone
    UserAuthAuthenticationProviderTypeEnumFilter:
      properties:
        eq:
          description: Search by type
          enum:
            - EMAIL_PASSWORD
            - OIDC
            - SUPPORT_ACCESS
          type: string
        in:
          description: Search by type
          items:
            enum:
              - EMAIL_PASSWORD
              - OIDC
              - SUPPORT_ACCESS
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by type
          enum:
            - EMAIL_PASSWORD
            - OIDC
            - SUPPORT_ACCESS
          type: string
      title: UserAuthAuthenticationProviderTypeEnumFilter
      type: object
      description: UserAuthAuthenticationProviderTypeEnumFilter
    UserAuthenticationProviderSort:
      properties:
        type:
          enum:
            - ASC
            - DESC
          type: string
      title: UserAuthenticationProviderSort
      type: object
      description: UserAuthenticationProviderSort
    UserAuthFilter:
      properties:
        type:
          allOf:
            - $ref: >-
                #/components/schemas/UserAuthAuthenticationProviderTypeEnumFilter
          description: Search by type
      title: UserAuthFilter
      type: object
      description: UserAuthFilter
    UserCreatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/User'
      required:
        - payload
      type: object
      title: UserCreatedWebHookEvent
      description: UserCreatedWebHookEvent
    UserCustomClaimsFilter:
      properties:
        roles:
          allOf:
            - $ref: '#/components/schemas/UserCustomClaimsRolesListFilter'
          description: Nested list search by roles
      title: UserCustomClaimsFilter
      type: object
      description: UserCustomClaimsFilter
    UserCustomClaimsRolesFilter:
      properties:
        facilities:
          allOf:
            - $ref: '#/components/schemas/StringListFilter'
          description: Search by facilities
        name:
          allOf:
            - $ref: >-
                #/components/schemas/UserCustomClaimsRolesUserRoleNamesEnumFilter
          description: Search by name
      title: UserCustomClaimsRolesFilter
      type: object
      description: UserCustomClaimsRolesFilter
    UserCustomClaimsRolesListFilter:
      properties:
        contains:
          allOf:
            - $ref: '#/components/schemas/UserCustomClaimsRolesFilter'
          description: Contains returns if at least one entry matches
        exists:
          description: >-
            exists:false matches empty or absent lists; exists:true matches
            non-empty lists
          type: boolean
      title: UserCustomClaimsRolesListFilter
      type: object
      description: UserCustomClaimsRolesListFilter
    UserCustomClaimsRolesUserRoleNamesEnumFilter:
      properties:
        eq:
          description: Search by name
          enum:
            - FULFILLER
            - SUPERVISOR
            - ADMINISTRATOR
          type: string
        in:
          description: Search by name
          items:
            enum:
              - FULFILLER
              - SUPERVISOR
              - ADMINISTRATOR
            type: string
          maxItems: 500
          type: array
        notEq:
          description: Search by name
          enum:
            - FULFILLER
            - SUPERVISOR
            - ADMINISTRATOR
          type: string
      title: UserCustomClaimsRolesUserRoleNamesEnumFilter
      type: object
      description: UserCustomClaimsRolesUserRoleNamesEnumFilter
    UserDeletedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/User'
      required:
        - payload
      type: object
      title: UserDeletedWebHookEvent
      description: UserDeletedWebHookEvent
    UserForCreation:
      properties:
        assignedFacilities:
          description: The assigned facilities of the user
          items:
            $ref: '#/components/schemas/UserAssignedFacilityForCreation'
          type: array
        assignedRoles:
          description: The roles which are assigned to the user
          items:
            $ref: '#/components/schemas/AssignedRoles'
          maxItems: 10
          minItems: 1
          type: array
        customAttributes:
          description: The custom attributes of the user
          nullable: true
          type: object
        email:
          description: The email of the user
          example: john.doe@example.com
          type: string
        firstname:
          description: The first name of the user
          example: John
          type: string
        lastname:
          description: The last name of the user
          example: Doe
          type: string
        locale:
          $ref: '#/components/schemas/SupportedLocale'
        password:
          description: The password of the user
          example: elephantMangoDance123
          type: string
        roles:
          deprecated: true
          description: 'Deprecated: Use assignedRoles instead'
          items:
            $ref: '#/components/schemas/UserRole'
          maxItems: 1
          minItems: 1
          type: array
        username:
          description: The username of the user
          example: johndoe
          type: string
      required:
        - firstname
        - lastname
        - username
        - password
      title: UserForCreation
      type: object
      description: UserForCreation
    UserModificationHistory:
      additionalProperties: false
      properties:
        modificationDate:
          format: date-time
          type: string
        userId:
          description: ID of the user who commited this modification
          type: string
        username:
          description: Username of the user who commited this modification
          type: string
      required:
        - modificationDate
        - username
      type: object
      title: UserModificationHistory
      description: UserModificationHistory
    UserPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
        users:
          items:
            $ref: '#/components/schemas/User'
          type: array
      required:
        - pageInfo
        - users
      title: UserPaginatedResult
      type: object
      description: UserPaginatedResult
    UserPasswordResetAction:
      properties:
        name:
          allOf:
            - $ref: '#/components/schemas/UserPublicActionEnum'
          description: The action to perform
        username:
          description: The username to request password reset for
          example: johndoe
          type: string
      required:
        - name
        - username
      title: UserPasswordResetAction
      type: object
      description: UserPasswordResetAction
    UserPatchActions:
      properties:
        actions:
          description: The actions to perform
          items:
            $ref: '#/components/schemas/ModifyUserAction'
          maxItems: 5
          type: array
        version:
          description: The version of the user to modify
          example: 1
          type: number
      required:
        - actions
        - version
      title: UserPatchActions
      type: object
      description: UserPatchActions
    UserPublicActionEnum:
      description: The action to perform
      enum:
        - REQUEST_PASSWORD_RESET
      title: UserPublicActionEnum
      type: string
    UserRole:
      properties:
        context:
          description: >-
            An array of context objects, each defining a type and its allowed
            values — if a type is omitted, access for that type is unrestricted;
            if included, access is limited to the specified values, and each
            type must appear at most once.
          items:
            $ref: '#/components/schemas/ContextLimitation'
          type: array
        contextLimitations:
          deprecated: true
          description: The context limitations for this role (deprecated)
          items:
            $ref: '#/components/schemas/ContextLimitation'
          type: array
        facilities:
          deprecated: true
          description: >-
            Facility limitations are now defined in the context with type
            FACILITY
          items:
            type: string
          maxItems: 23
          type: array
        name:
          description: The name of the role
          type: string
      required:
        - name
      title: UserRole
      type: object
      description: UserRole
    UserRoleNames:
      description: All available user roles
      enum:
        - FULFILLER
        - SUPERVISOR
        - ADMINISTRATOR
      type: string
      xml:
        name: UserRoleNames
      title: UserRoleNames
    UserRoleWithPermissions:
      properties:
        context:
          description: >-
            An array of context objects, each defining a type and its allowed
            values — if a type is omitted, access for that type is unrestricted;
            if included, access is limited to the specified values, and each
            type must appear at most once.
          items:
            $ref: '#/components/schemas/ContextLimitation'
          type: array
        contextLimitations:
          deprecated: true
          description: The context limitations for this role (deprecated)
          items:
            $ref: '#/components/schemas/ContextLimitation'
          type: array
        facilities:
          deprecated: true
          description: >-
            Facility limitations are now defined in the context with type
            FACILITY
          items:
            type: string
          maxItems: 23
          type: array
        name:
          description: The name of the role
          type: string
        permissions:
          description: >-
            The permissions associated with the role, which define what actions
            the role can perform.
          items:
            enum:
              - USER_READ
              - USERS_READ
              - USER_WRITE
              - USER_MODIFY
              - CURRENT_USER_READ
              - CURRENT_USER_MODIFY
              - ROLE_READ
              - ROLE_WRITE
              - FACILITY_READ
              - FACILITY_WRITE
              - FACILITY_CREATE
              - FACILITY_DELETE
              - FACILITY_GROUP_READ
              - FACILITY_GROUP_WRITE
              - ORDER_READ
              - ORDER_WRITE
              - ORDER_FORCE_CANCEL
              - ORDER_UNLOCK
              - ORDER_CANCEL
              - ORDER_CONSUMER_WRITE
              - ORDER_CUSTOM_ATTRIBUTES_WRITE
              - ORDER_LINEITEM_WRITE
              - ORDER_TOTAL_READ
              - LINE_ITEM_PRICING_READ
              - LINE_ITEM_QUANTITY_INCREASE
              - LINE_ITEM_ADD
              - LINE_ITEM_QUANTITY_DECREASE
              - LINE_ITEM_DELETE
              - SIMULATION_ORDER_READ
              - SIMULATION_ORDER_WRITE
              - AUDIT_READ
              - NOTIFICATION_READ
              - NOTIFICATION_WRITE
              - EXPIRIES_READ
              - EXPIRIES_WRITE
              - CONFIG_READ
              - CONFIG_WRITE
              - ROUTING_CONFIG_READ
              - ROUTING_CONFIG_WRITE
              - PROMISES_CONFIG_READ
              - PROMISES_CONFIG_WRITE
              - OIDC_PROVIDERS_CONFIG_READ
              - OIDC_PROVIDERS_CONFIG_WRITE
              - LOCALE_WRITE
              - CARRIER_READ
              - CARRIER_WRITE
              - RETURN_WRITE
              - RETURN_READ
              - ROUTING_READ
              - ROUTING_WRITE
              - PARCEL_READ
              - PARCEL_WRITE
              - SHIPMENT_READ
              - SHIPMENT_WRITE
              - HANDOVERJOB_READ
              - HANDOVERJOB_WRITE
              - PICKJOB_READ
              - PICKJOB_WRITE
              - PICKJOB_REROUTE
              - REMOTE_CONFIG_READ
              - REMOTE_CONFIG_WRITE
              - PICKRUN_READ
              - PICKRUN_WRITE
              - LOADUNITTYPE_READ
              - LOADUNITTYPE_WRITE
              - LOADUNIT_READ
              - LOADUNIT_WRITE
              - MEASUREMENTUNIT_READ
              - MEASUREMENTUNIT_WRITE
              - EVENT_READ
              - SUBSCRIPTION_READ
              - SUBSCRIPTION_WRITE
              - SUBSTITUTE_READ
              - SUBSTITUTE_WRITE
              - PROCESS_READ
              - PROCESS_WRITE
              - PROCESS_REROUTE
              - EXTERNAL_ACTIONS_READ
              - EXTERNAL_ACTIONS_WRITE
              - PROCESS_LOG_READ
              - OPERATIVE_PROCESS_READ
              - OPERATIVE_PROCESS_WRITE
              - DELIVERYNOTE_WRITE
              - PACKJOB_READ
              - PACKJOB_WRITE
              - PACKINGCONTAINER_TYPE_WRITE
              - PACKING_SOURCE_CONTAINER_READ
              - PACKING_SOURCE_CONTAINER_WRITE
              - RESTOW_ITEM_READ
              - RESTOW_ITEM_WRITE
              - TAG_READ
              - TAG_WRITE
              - STOCK_READ
              - STOCK_WRITE
              - EXTERNAL_STOCK_CHANGE_REASONS_READ
              - EXTERNAL_STOCK_CHANGE_REASONS_WRITE
              - STORAGE_LOCATION_READ
              - STORAGE_LOCATION_WRITE
              - STOW_JOB_READ
              - STOW_JOB_OPERATIVE_WRITE
              - STOW_JOB_FULL_WRITE
              - NOTIFICATION_CENTER_CONFIG_READ
              - NOTIFICATION_CENTER_CONFIG_WRITE
              - DOMS_TOOLKIT_READ
              - DOMS_TOOLKIT_WRITE
              - ANALYTICS_DASHBOARD_READ
              - DOCUMENT_SET_READ
              - DOCUMENT_SET_WRITE
              - INBOUND_PROCESS_READ
              - INBOUND_PROCESS_WRITE
              - ADMIN_DATA_RESET
              - ADMIN_MODULES_READ
              - ADMIN_MODULES_WRITE
              - TENANT_CONNECTOR_CONFIG_READ
              - CUSTOM_SERVICE_WRITE
              - CUSTOM_SERVICE_READ
              - VALIDATIONS_READ
              - SERVICE_JOB_READ
              - SERVICE_JOB_WRITE
              - LINKED_SERVICE_JOBS_READ
              - LINKED_SERVICE_JOBS_WRITE
              - OPERATION_STATISTICS_READ
              - DOMS_STATISTICS_READ
              - AVAILABILITY_CHANNEL_READ
              - AVAILABILITY_CHANNEL_WRITE
              - HANDOVER_CONTAINER_READ
              - HANDOVER_CONTAINER_WRITE
              - STACKS_READ
              - STACKS_WRITE
              - CATEGORY_READ
              - CATEGORY_WRITE
              - PERMISSION_READ
              - KPI_READ
              - AI_ASSISTANT_ACCESS
              - RESERVATION_WRITE
              - RESERVATION_READ
              - FILTER_ENTITY_READ
              - BRAND_READ
              - WORKFLOW_DEFINITION_READ
              - WORKFLOW_DEFINITION_WRITE
              - LOOKUP_RECORD_READ
              - LOOKUP_RECORD_WRITE
              - ORDER_RECORD_READ
              - ORDER_RECORD_WRITE
              - PACKAGING_UNITS_READ
              - PACKAGING_UNITS_WRITE
              - EXPORT_READ
              - EXPORT_WRITE
              - STOCK_AVAILABILITIES_READ
              - LISTING_READ
              - LISTING_WRITE
              - LISTING_DELETE
              - PURCHASE_PRICE_READ
              - ZONE_READ
              - ZONE_WRITE
              - SAFETY_STOCK_READ
              - SAFETY_STOCK_WRITE
            type: string
          type: array
      required:
        - name
      title: UserRoleWithPermissions
      type: object
      description: UserRoleWithPermissions
    UserSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/UserSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/UserSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: UserSearchPayload
      type: object
      description: UserSearchPayload
    UserSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/UserSearchQuery'
          maxItems: 500
          type: array
        assignedFacilities:
          allOf:
            - $ref: '#/components/schemas/UserAssignedFacilitiesListFilter'
          description: Nested list search by assignedFacilities
        assignedRoles:
          allOf:
            - $ref: '#/components/schemas/UserAssignedRolesListFilter'
          description: Nested list search by assignedRoles
        auth:
          allOf:
            - $ref: '#/components/schemas/UserAuthFilter'
          description: Nested search by auth
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        customClaims:
          allOf:
            - $ref: '#/components/schemas/UserCustomClaimsFilter'
          description: Nested search by customClaims
        facilityLimitations:
          allOf:
            - $ref: '#/components/schemas/StringListExistsFilter'
          description: Search by facilityLimitations
        firstname:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by firstname
          example: Phil
        lastModified:
          allOf:
            - $ref: '#/components/schemas/DateFilter'
          description: Search by lastModified
        lastname:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by lastname
          example: Bison
        or:
          items:
            $ref: '#/components/schemas/UserSearchQuery'
          maxItems: 500
          type: array
        username:
          allOf:
            - $ref: '#/components/schemas/StringSearchFilter'
          description: Search by username
      title: UserSearchQuery
      type: object
      description: UserSearchQuery
    UserSort:
      properties:
        assignedRoles:
          $ref: '#/components/schemas/UserAssignedRolesSort'
        authenticationProvider:
          $ref: '#/components/schemas/UserAuthenticationProviderSort'
        customAttributes:
          additionalProperties: true
          maxProperties: 1
          minProperties: 1
          type: object
        firstname:
          enum:
            - ASC
            - DESC
          type: string
        lastLogin:
          enum:
            - ASC
            - DESC
          type: string
        lastname:
          enum:
            - ASC
            - DESC
          type: string
        username:
          enum:
            - ASC
            - DESC
          type: string
      title: UserSort
      type: object
      description: UserSort
    UserUpdatedWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/User'
      required:
        - payload
      type: object
      title: UserUpdatedWebHookEvent
      description: UserUpdatedWebHookEvent
    VceCarrierConfiguration:
      properties:
        additionalWeightInPercent:
          description: >-
            It is an amount of percentage for packaging weight which will be
            added to the calculated shipping weight
          minimum: 0
          type: number
        alternativeReturnAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative return address for this carrier
        alternativeSendAddress:
          allOf:
            - $ref: '#/components/schemas/FacilityAddress'
          description: Alternative send address for this carrier
        carrierRef:
          description: Reference to the carrier this configuration belongs to
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        countryServiceMappings:
          description: Country service mappings for this carrier configuration
          items:
            $ref: '#/components/schemas/CarrierCountryServiceMapping'
          maxItems: 100
          type: array
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          format: date-time
          type: string
        defaultPickUpTime:
          allOf:
            - $ref: '#/components/schemas/CarrierPickUpTime'
          description: >-
            Default pick up time configuration for carriers supporting pick up
            scheduling, will be used to calculate the next possible pick up date
          example: 2026-06-17T12:00:00.000Z
        fallBackTrackAndTraceEmail:
          description: >-
            EmailAddress used to receive track and trace information when no
            other emailaddress was provided
          example: max@speedyboxales.com
          format: email
          minLength: 1
          type: string
        id:
          description: The id of the carrier configuration
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          format: date-time
          type: string
        mustBeWeighed:
          default: false
          description: >-
            Indicates if the content of a parcel must be weighed before ordering
            a label
          example: false
          type: boolean
        nonDeliveryDaysPerCountryAndProvince:
          description: Non-delivery days per country and province
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerCountryAndProvince'
          maxItems: 500
          type: array
        returnLabel:
          default: false
          description: >-
            When enabled, a return label will be created by creating a shipping
            label
          example: false
          type: boolean
        serviceUrl:
          description: Service URL for this carrier configuration
          example: https://example.com/resource
          type: string
        thresholdPriceValue:
          allOf:
            - $ref: '#/components/schemas/ThresholdPriceValue'
          description: Threshold price value for carrier selection
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          type: integer
      required:
        - version
        - carrierRef
        - returnLabel
      title: VceCarrierConfiguration
      type: object
      description: VceCarrierConfiguration
    VersionedResource:
      properties:
        created:
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
          example: 2020-02-03T08:45:51.525Z
          format: date-time
          type: string
        lastModified:
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
          example: 2020-02-03T09:45:51.525Z
          format: date-time
          type: string
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      title: VersionedResource
      description: VersionedResource
    VersionlessUpdateStock:
      properties:
        name:
          enum:
            - UPDATE_VERSIONLESS
          type: string
        stocks:
          description: >-
            Please be sure to include each stock (by ID) only once, when
            updating. Otherwise the whole batch is rejected with an error.
          items:
            discriminator:
              propertyName: operationType
            oneOf:
              - $ref: '#/components/schemas/StockForCreationVersionless'
              - $ref: '#/components/schemas/StockForUpdateVersionless'
          maxItems: 25
          type: array
      required:
        - name
        - stocks
      title: VersionlessUpdateStock
      type: object
      description: VersionlessUpdateStock
    WaitForInputItemReturnActionParameter:
      properties:
        itemReturnJobVersion:
          description: Version of the entity to be changed
          example: 1
          minimum: 0
          type: integer
        name:
          enum:
            - WaitForInputItemReturn
          type: string
      required:
        - name
        - itemReturnJobVersion
      title: WaitForInputItemReturnActionParameter
      type: object
      description: WaitForInputItemReturnActionParameter
    WebHookEvent:
      properties:
        event:
          description: The type of the send event
          type: string
        eventId:
          description: The id of the event
          type: string
      required:
        - event
        - eventId
      type: object
      title: WebHookEvent
      description: WebHookEvent
    WeekDay:
      description: A weekday
      enum:
        - MONDAY
        - TUESDAY
        - WEDNESDAY
        - THURSDAY
        - FRIDAY
        - SATURDAY
        - SUNDAY
      type: string
      xml:
        name: WeekDay
      title: WeekDay
    WorkflowCondition:
      properties:
        entity:
          description: Entity type that the condition applies to
          enum:
            - ORDER
            - INCOMING_EVENT
            - FACILITY
          type: string
        expression:
          description: Expression that defines the condition
          type: string
      required:
        - expression
        - entity
      title: WorkflowCondition
      type: object
      description: WorkflowCondition
    WorkflowConnection:
      properties:
        from:
          description: >-
            Source node key. For condition nodes, may include .TRUE or .FALSE
            suffix (e.g., "fraud-check.TRUE")
          type: string
        to:
          description: >-
            Target node key. For condition nodes, may include .TRUE or .FALSE
            suffix (e.g., "fraud-check.FALSE")
          type: string
      required:
        - from
        - to
      title: WorkflowConnection
      type: object
      description: WorkflowConnection
    WorkflowDefinition:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowNameLocaleStringRequired'
          description: >-
            Localized human-readable name of the workflow. At least one locale
            value is required.
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowDescriptionLocaleString'
          description: Localized description of what the workflow does
        connections:
          description: Array of connections between workflow nodes
          items:
            $ref: '#/components/schemas/WorkflowConnection'
          maxItems: 10
          type: array
        description:
          description: Description resolved to the requesting user's locale (read-only)
          type: string
        id:
          description: Unique identifier for the workflow definition
          example: 507f1f77bcf86cd799439011
          type: string
        isActive:
          description: Whether the workflow definition is active
          example: true
          type: boolean
        name:
          description: Name resolved to the requesting user's locale (read-only)
          type: string
        nodes:
          description: Array of workflow nodes
          items:
            oneOf:
              - $ref: '#/components/schemas/FFTActivityNode'
              - $ref: '#/components/schemas/GuardWorkflowNode'
              - $ref: '#/components/schemas/ConditionWorkflowNode'
          maxItems: 100
          type: array
        rootId:
          description: Key of the root node where workflow execution begins
          example: order-node
          type: string
        tenantWorkflowId:
          description: >-
            Unique tenant id for the workflow definition. Must not contain "."
            or "$" characters.
          example: fraud-check-workflow
          type: string
        type:
          description: Type of workflow. Currently only ORDER workflows are supported
          enum:
            - ORDER
          type: string
        version:
          description: Current version of the workflow definition for optimistic locking
          example: 1
          type: number
      required:
        - tenantWorkflowId
        - type
        - nameLocalized
        - rootId
        - nodes
        - connections
        - id
        - version
        - isActive
      title: WorkflowDefinition
      type: object
      description: WorkflowDefinition
    WorkflowDefinitionAction:
      properties:
        name:
          description: Which action to perform on the workflow definition
          enum:
            - ACTIVATE
          type: string
      required:
        - name
      title: WorkflowDefinitionAction
      type: object
      description: WorkflowDefinitionAction
    WorkflowDefinitionForCreation:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowNameLocaleStringRequired'
          description: >-
            Localized human-readable name of the workflow. At least one locale
            value is required.
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowDescriptionLocaleString'
          description: Localized description of what the workflow does
        connections:
          description: Array of connections between workflow nodes
          items:
            $ref: '#/components/schemas/WorkflowConnection'
          maxItems: 10
          type: array
        nodes:
          description: Array of workflow nodes
          items:
            oneOf:
              - $ref: '#/components/schemas/FFTActivityNode'
              - $ref: '#/components/schemas/GuardWorkflowNode'
              - $ref: '#/components/schemas/ConditionWorkflowNode'
          maxItems: 100
          type: array
        rootId:
          description: Key of the root node where workflow execution begins
          example: order-node
          type: string
        tenantWorkflowId:
          description: >-
            Unique tenant id for the workflow definition. Must not contain "."
            or "$" characters.
          example: fraud-check-workflow
          type: string
        type:
          description: Type of workflow. Currently only ORDER workflows are supported
          enum:
            - ORDER
          type: string
      required:
        - tenantWorkflowId
        - type
        - nameLocalized
        - rootId
        - nodes
        - connections
      title: WorkflowDefinitionForCreation
      type: object
      description: WorkflowDefinitionForCreation
    WorkflowDefinitionForUpdate:
      properties:
        nameLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowNameLocaleStringRequired'
          description: >-
            Localized human-readable name of the workflow. At least one locale
            value is required.
        descriptionLocalized:
          allOf:
            - $ref: '#/components/schemas/WorkflowDescriptionLocaleString'
          description: Localized description of what the workflow does
        connections:
          description: Array of connections between workflow nodes
          items:
            $ref: '#/components/schemas/WorkflowConnection'
          maxItems: 10
          type: array
        id:
          description: Unique identifier for the workflow definition
          example: 507f1f77bcf86cd799439011
          type: string
        nodes:
          description: Array of workflow nodes
          items:
            oneOf:
              - $ref: '#/components/schemas/FFTActivityNode'
              - $ref: '#/components/schemas/GuardWorkflowNode'
              - $ref: '#/components/schemas/ConditionWorkflowNode'
          maxItems: 100
          type: array
        rootId:
          description: Key of the root node where workflow execution begins
          example: order-node
          type: string
        tenantWorkflowId:
          description: >-
            Unique tenant id for the workflow definition. Must not contain "."
            or "$" characters.
          example: fraud-check-workflow
          type: string
        type:
          description: Type of workflow. Currently only ORDER workflows are supported
          enum:
            - ORDER
          type: string
        version:
          description: Current version of the workflow definition for optimistic locking
          example: 1
          type: number
      required:
        - tenantWorkflowId
        - type
        - nameLocalized
        - rootId
        - nodes
        - connections
        - id
        - version
      title: WorkflowDefinitionForUpdate
      type: object
      description: WorkflowDefinitionForUpdate
    WorkflowDescriptionLocaleString:
      additionalProperties:
        maxLength: 500
        minLength: 2
        type: string
      description: >-
        Provides localized values. The key is the locale, the value is the
        translation.
        https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
      example:
        de_DE: Betrugsprüfungs-Workflow
        en_US: Fraud check workflow
      title: WorkflowDescriptionLocaleString
      type: object
    WorkflowInformation:
      additionalProperties: false
      properties:
        instanceRef:
          description: The ID identifying the workflow instance this entity belongs to.
          example: 64c13ab08edf48a008793cac
          type: string
        isAvailable:
          description: Explicitly states if this entity is part of a workflow.
          enum:
            - true
          type: boolean
        nodeRef:
          description: >-
            The ID identifying the node within the workflow instance tha this
            entity belongs to.
          type: string
      title: WorkflowInformation
      type: object
      description: WorkflowInformation
    WorkflowNameLocaleString:
      additionalProperties:
        maxLength: 100
        minLength: 2
        type: string
      description: >-
        Provides localized values. The key is the locale, the value is the
        translation.
        https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
      example:
        de_DE: Betrugsprüfung
        en_US: Fraud Check
      title: WorkflowNameLocaleString
      type: object
    WorkflowNameLocaleStringRequired:
      additionalProperties:
        maxLength: 100
        minLength: 2
        type: string
      description: >-
        Provides localized values. The key is the locale, the value is the
        translation.
        https://docs.fulfillmenttools.com/documentation/getting-started/authentication-and-authorization/localization
      example:
        de_DE: Betrugsprüfung
        en_US: Fraud Check
      minProperties: 1
      title: WorkflowNameLocaleStringRequired
      type: object
    WorkflowPaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
        workflows:
          items:
            $ref: '#/components/schemas/WorkflowDefinition'
          type: array
      required:
        - pageInfo
        - workflows
      title: WorkflowPaginatedResult
      type: object
      description: WorkflowPaginatedResult
    WorkflowSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/WorkflowSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/WorkflowSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: WorkflowSearchPayload
      type: object
      description: WorkflowSearchPayload
    WorkflowSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/WorkflowSearchQuery'
          maxItems: 500
          type: array
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        isActive:
          allOf:
            - $ref: '#/components/schemas/BooleanFilter'
          description: Search by isActive
        name:
          allOf:
            - $ref: '#/components/schemas/LocalizedStringSearchFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/WorkflowSearchQuery'
          maxItems: 500
          type: array
        tenantWorkflowId:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by tenantWorkflowId
          example: MY_WORKFLOW_ID
      title: WorkflowSearchQuery
      type: object
      description: WorkflowSearchQuery
    WorkflowSort:
      properties:
        id:
          enum:
            - ASC
            - DESC
          type: string
      title: WorkflowSort
      type: object
      description: WorkflowSort
    WorkflowUnavailable:
      additionalProperties: false
      properties:
        isAvailable:
          description: Explicitly states if this entity is part of a workflow.
          enum:
            - false
          type: boolean
      title: WorkflowUnavailable
      type: object
      description: WorkflowUnavailable
    Zone:
      allOf:
        - $ref: '#/components/schemas/ZoneForReplacement'
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        id:
          description: The id of this zone
          type: string
      required:
        - id
        - facilityRef
      type: object
      xml:
        name: Zone
      title: Zone
      description: Zone
    ZoneForCreation:
      allOf:
        - $ref: '#/components/schemas/CustomAttributesResource'
      properties:
        name:
          description: The name of this zone
          type: string
        score:
          description: The score of this zone
          type: number
      required:
        - name
        - score
      type: object
      xml:
        name: ZoneForCreation
      title: ZoneForCreation
      description: ZoneForCreation
    ZoneForReplacement:
      allOf:
        - $ref: '#/components/schemas/ZoneForCreation'
      properties:
        version:
          example: 42
          format: int64
          type: integer
      required:
        - version
      type: object
      xml:
        name: ZoneForReplacement
      title: ZoneForReplacement
      description: ZoneForReplacement
    ZonePaginatedResult:
      properties:
        pageInfo:
          allOf:
            - $ref: '#/components/schemas/PageInfo'
          description: Pagination information for the search result.
        total:
          description: >-
            The total number of items matching the search criteria. Only filled,
            if withTotal is set to true in the search options.
          minimum: 0
          type: number
        zones:
          items:
            $ref: '#/components/schemas/Zone'
          type: array
      required:
        - pageInfo
        - zones
      title: ZonePaginatedResult
      type: object
      description: ZonePaginatedResult
    ZoneSearchPayload:
      properties:
        after:
          deprecated: false
          description: >-
            The cursor to start after for forward pagination. The value is
            provided in the `pageInfo.endCursor` field of the response. Cannot
            be used with `before` or `last`.
          type: string
        before:
          description: >-
            The cursor to start before for backward pagination. The value is
            provided in the `pageInfo.startCursor` field of the response. Cannot
            be used with `after` or `size` (first).
          type: string
        last:
          description: >-
            Number of items to return for backward pagination. Cannot be used
            with 'size' (first). Default: 20.
          maximum: 250
          minimum: 1
          type: number
        options:
          $ref: '#/components/schemas/SearchOptions'
        query:
          $ref: '#/components/schemas/ZoneSearchQuery'
        size:
          description: >-
            Number of items to return for forward pagination. Cannot be used
            with 'last'. Default: 20.
          example: 10
          maximum: 250
          minimum: 1
          type: number
        sort:
          description: Use for sorting the result.
          items:
            $ref: '#/components/schemas/ZoneSort'
          maxItems: 1
          minItems: 1
          type: array
        startAfterId:
          deprecated: true
          description: >-
            The ID to start after. Deprecated, use `after` with the value
            provided in `pageInfo.endCursor` instead.
          type: string
      required:
        - query
      title: ZoneSearchPayload
      type: object
      description: ZoneSearchPayload
    ZoneSearchQuery:
      properties:
        and:
          items:
            $ref: '#/components/schemas/ZoneSearchQuery'
          maxItems: 500
          type: array
        customAttributes:
          additionalProperties:
            anyOf:
              - $ref: '#/components/schemas/BooleanFilter'
              - $ref: '#/components/schemas/StringEqFilter'
              - $ref: '#/components/schemas/NumberEqFilter'
              - $ref: '#/components/schemas/DateFilter'
          description: Search by custom attributes
          type: object
        facilityRef:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by facilityRef
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        id:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by id
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
        name:
          allOf:
            - $ref: '#/components/schemas/StringFilter'
          description: Search by name
        or:
          items:
            $ref: '#/components/schemas/ZoneSearchQuery'
          maxItems: 500
          type: array
      title: ZoneSearchQuery
      type: object
      description: ZoneSearchQuery
    ZoneSort:
      properties:
        lastModified:
          enum:
            - ASC
            - DESC
          type: string
      title: ZoneSort
      type: object
      description: ZoneSort
    ZoneWebHookEventPayload:
      properties:
        created:
          description: The date when the zone was created
          format: date-time
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to this entity. These attributes
            **cannot** be used within fulfillment processes, but enable you to
            attach custom data from your systems to fulfillmenttools entities.
          nullable: true
          type: object
        facilityRef:
          description: The reference to the facility associated with the zone
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        id:
          description: The unique identifier of the zone
          example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f
          type: string
        lastModified:
          description: The date when the zone was last modified
          format: date-time
          type: string
        name:
          description: The name of the zone
          type: string
        score:
          description: The score of the zone
          type: number
        version:
          description: The version of the zone
          example: 1
          type: number
      required:
        - version
        - id
        - facilityRef
        - name
        - score
      title: ZoneWebHookEventPayload
      type: object
      description: ZoneWebHookEventPayload
    ZoneWebHookEventPayloadWebHookEvent:
      allOf:
        - $ref: '#/components/schemas/WebHookEvent'
      properties:
        payload:
          $ref: '#/components/schemas/ZoneWebHookEventPayload'
      required:
        - payload
      title: ZoneWebHookEventPayloadWebHookEvent
      type: object
      description: ZoneWebHookEventPayloadWebHookEvent
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
tags:
  - description: >-
      Endpoints used by shops to get the current available pickup stores and
      available service levels like Same-Day delivery.
    name: Checkout Options (DOMS)
  - description: DOMS endpoints to create, retrieve, update, and manage customer orders.
    name: Orders (DOMS)
  - description: >-
      DOMS endpoints to define and manage configuration settings related to
      order processing, such as defaults, business rules, and operational
      parameters that influence how orders are handled.
    name: Orders Configuration (DOMS)
  - description: >-
      Endpoints for managing orders that have already been completed and do not
      need to participate in the fulfillment lifecycle.
    name: Order Records (DOMS)
  - description: Endpoints for managing packaging units.
    name: PackagingUnits (DOMS)
  - description: >-
      Endpoints to get information out of the brain of our Distributed Order
      Management System (DOMS).
    name: Routing Plans (DOMS)
  - description: Endpoints for configuring routing plan handling.
    name: Routing Plans Configuration (DOMS)
  - description: Endpoints to configure the routing strategy of the DOMS.
    name: Routing Strategy (DOMS)
  - description: Endpoints for processing the routing decision logs.
    name: Sourcing Options (DOMS)
  - description: Endpoints to create, update, and read carriers.
    name: Carriers (Operations)
  - description: Endpoints to create, update, and read carriers configuration.
    name: Carriers Configuration (Operations)
  - description: These endpoints manage the handover process.
    name: Handovers (Operations)
  - description: Endpoints to create, update, and read handover configuration.
    name: Handovers Configuration (Operations)
  - description: Endpoints to manipulate operative containers.
    name: Operative Container (Operations)
  - description: Get operative processes.
    name: Operative Process (Operations)
  - description: These endpoints facilitate the packing process.
    name: Packing (Operations)
  - description: Endpoints to create, update, and read packing configuration.
    name: Packing Configuration (Operations)
  - description: These endpoints support the management of the picking process.
    name: Picking (Operations)
  - description: Endpoints to create, update, and read pick jobs.
    name: Picking Configuration (Operations)
  - description: Endpoints to manipulate restowing items.
    name: Restowing (Operations)
  - description: Endpoints to manipulate restowing configuration.
    name: Restowing Configuration (Operations)
  - description: Endpoints to create, update, and read returns.
    name: Returns (Operations)
  - description: Endpoints to create, update, and read returns configuration.
    name: Returns Configuration (Operations)
  - description: Endpoints to create, update, and read operative service jobs.
    name: Services (Operations)
  - description: >-
      Endpoints to create, update, and read operative service jobs
      configuration.
    name: Services Configuration (Operations)
  - description: Endpoints to create, update, and read shipments and parcels.
    name: Shipments (Operations)
  - description: Endpoints to create, update, and read shipping configuration.
    name: Shipments Configuration (Operations)
  - description: Endpoints to operate with stacks.
    name: Stacks (Operations)
  - description: Endpoints to create, update, and read categories.
    name: Categories (Inventory)
  - description: Endpoints to configure and get channel availability.
    name: Channel Availability (Inventory)
  - description: Endpoints to create, update, and read inbound processes and receipts.
    name: Inbound (Inventory)
  - description: These endpoints handle the reservations.
    name: Reservations (Inventory)
  - description: Endpoints to create, update, and read stocks.
    name: Stocks (Inventory)
  - description: Endpoints to create, update, and read stocks configuration.
    name: Stocks Configuration (Inventory)
  - description: Endpoints to create, update, and read storage locations and zones.
    name: Storage Locations (Inventory)
  - description: Endpoints to create, update, and read stow jobs.
    name: Stowing (Inventory)
  - description: Auditing helps determine who did what when.
    name: Audits (Core)
  - description: Endpoints to update and read general configuration of fulfillmenttools.
    name: Configurations (Core)
  - description: Endpoints to create, update, and read custom services.
    name: Custom Services (Core)
  - description: Endpoints to create, update, and read document sets and files.
    name: Document Sets (Core)
  - description: Endpoints to create, update, and read subscriptions.
    name: Eventing (Core)
  - description: Endpoints to create, update, and read event scope configurations.
    name: Event Scope Configuration (Core)
  - description: >-
      Endpoints to read and modify expires, for example, by extending the
      provisioning time.
    name: Expiries (Core)
  - description: Endpoints to read and modify expires configuration.
    name: Expiries Configuration (Core)
  - description: >-
      Endpoints to attach external actions to processes and append logs to
      external actions.
    name: External Actions (Core)
  - description: >-
      Facilities represent various locations that form part of the fulfillment
      network.
    name: Facilities (Core)
  - description: Facility groups combine one or multiple facilities into logical groups.
    name: Facility Groups (Core)
  - description: Endpoints to create, update, and read facility listings.
    name: Listings (Core)
  - description: Endpoints to create, update and read measurement units.
    name: Measurement Units (Core)
  - description: Endpoints to configure the notification center.
    name: Notification Center Configuration (Core)
  - description: A process groups all entities of an order.
    name: Processes (Core)
  - description: Endpoints to create, update, and read remote configs.
    name: Remote Configs (Core)
  - description: Endpoints to create, update, and read tags.
    name: Tags (Core)
  - description: >-
      These endpoints enable the administration of user accounts, including
      creation, updating, read, and deletion of user accounts.
    name: User Management (Core)
  - description: Validate properties accepted by fulfillmenttools.
    name: Validations (Core)
  - description: Obtain artifact information provided by fulfillmenttools.
    name: Artifacts (Infrastructure)
  - description: Configure features of fulfillmenttools.
    name: Features (Infrastructure)
  - description: Access to the fulfillmenttools GraphQL API.
    name: GraphQL (Infrastructure)
  - description: Endpoints to get health status about fulfillmenttools.
    name: Health (Infrastructure)
  - description: Endpoints to configure external IDPs.
    name: OIDC Configuration (Infrastructure)
security:
  - BearerToken: []