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 - simplifying retail complexity
  version: VERSIONLESS
paths:
  /api/carriers:
    get:
      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: >-
            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/StrippedCarriers'
          description: The current list of available carriers
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: No more elements available
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: getCarriers
      summary: Returns all configured CEP partners
    post:
      parameters:
        - 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:
        '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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: addCarrier
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierForCreation'
        description: Carrier object
        required: true
      summary: Add a new carrier as a CEP partner
  /api/carriers/{carrierId}:
    get:
      parameters:
        - description: ID of the carrier you want to get
          in: path
          name: carrierId
          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/Carrier'
          description: >-
            Carrier was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: getCarrier
      summary: Get a carrier with the given ID
    patch:
      parameters:
        - description: ID of carrier you want to patch
          in: path
          name: carrierId
          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/Carrier'
          description: >-
            Carrier was found & patch-set has been applied. The patched entity
            is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: patchCarrier
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierPatchActions'
        description: Patch set
        required: true
      summary: Patches a carrier with the given ID
  /api/carriers/{carrierId}/configuration:
    get:
      parameters:
        - description: ID of the carrier you want to get the configuration
          in: path
          name: carrierId
          required: true
          schema:
            type: string
      responses:
        '200':
          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'
          description: >-
            Carrier Configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier Configuration not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: getCarrierConfiguration
      summary: Get a carrier configuration with the given ID
    put:
      parameters:
        - description: ID of the carrier you want to update the configuration
          in: path
          name: carrierId
          required: true
          schema:
            type: string
      responses:
        '200':
          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'
          description: >-
            Carrier Configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier Configuration not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: putCarrierConfiguration
      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'
        description: Carrier Configuration
        required: true
      summary: Update a carrier configuration with the given ID
  /api/carriers/{carrierId}/configuration/countryservicemappings:
    get:
      parameters:
        - description: ID of the carrier you want to get the countryservicemappings for
          in: path
          name: carrierId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CarrierCountryServiceMapping'
          description: >-
            Carrier's countryservicemappings found & you are allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier's countryservicemappings Configuration not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: getCarrierCountryServiceMappings
      summary: Get a CarrierCountryServiceMappings for carrier with given ID
    post:
      parameters:
        - description: ID of the carrier you want to create a countryservicemapping for
          in: path
          name: carrierId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: createCarrierCountryServiceMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCountryServiceMappingForCreation'
        description: Carrier Configuration
        required: true
      summary: Crwate a carrierCountryServiceMapping for carrier with given ID
  /api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}:
    get:
      parameters:
        - description: ID of the carrier you want to get a countryservicemapping for
          in: path
          name: carrierId
          required: true
          schema:
            type: string
        - description: ID of the countryservicemapping
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier's countryservicemappings Configuration not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: getCarrierCountryServiceMapping
      summary: Get a CarrierCountryServiceMappings for carrier with given ID
    patch:
      parameters:
        - description: ID of the carrier you want to update a countryservicemapping of
          in: path
          name: carrierId
          required: true
          schema:
            type: string
        - description: ID of the countryservicemapping
          in: path
          name: countryServiceMappingId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier or CarrierCountryServiceMapping not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: updateCarrierCountryServiceMapping
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierCountryServiceMappingForUpdate'
        description: Carrier Mapping for update
        required: true
      summary: Update a carrierCountryServiceMapping for carrier with given ID
    delete:
      parameters:
        - description: ID of the carrier you want to delete a countryservicemapping from
          in: path
          name: carrierId
          required: true
          schema:
            type: string
        - description: ID of the countryservicemapping
          in: path
          name: countryServiceMappingId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: CarrierCountryServiceMapping successfully deleted.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Carrier or CarrierCountryServiceMapping not found
      tags:
        - Last Mile Integration - Carriers
      description: ''
      operationId: deleteCarrierCountryServiceMapping
      summary: Delete a carrierCountryServiceMapping for carrier with given ID
  /api/configurations/transittime:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cutoff time configuration not found
      tags:
        - Last Mile Integration - Carriers
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getTransitTimeConfiguration
      summary: Get a tenant wide transit time time config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransitTimeConfiguration'
          description: Transit time configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Transit time configuration not found
      tags:
        - Last Mile Integration - Carriers
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putTransitTimeConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransitTimeConfigurationForUpsert'
        required: true
      summary: Update transit time configuration of a tenant
  /api/configurations/cutofftime:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cutoff time configuration not found
      tags:
        - Fulfillment Operations - Picking
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getCutoffTimeConfiguration
      summary: Get a tenant wide cutoff time config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CutoffTimeConfiguration'
          description: Cutoff time configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cutoff time configuration not found
      tags:
        - Fulfillment Operations - Picking
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putCutoffTimeConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CutoffTimeConfiguration'
        required: true
      summary: Update cutoff time configuration of a tenant
  /api/configurations/tenant:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Tenant configuration not found
      tags:
        - Core - Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getTenantConfiguration
      summary: Get a tenant config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantConfiguration'
          description: Tenant configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Tenant configuration not found
      tags:
        - Core - Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Upsert tenant configuration
      operationId: putTenantConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantConfigurationForUpsert'
        required: true
      summary: Update tenant configuration of a tenant
  /api/configurations/deliverynote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Delivery note configuration not found
      tags:
        - Fulfillment Operations - Shipments
      operationId: getDeliveryNoteConfiguration
      summary: Get a tenant wide delivery configuration
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      operationId: putDeliveryNoteConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryNoteConfigurationForUpsert'
        required: true
      summary: Update delivery note configuration of a tenant
  /api/configurations/tenantconnector:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: configuration not found
      tags:
        - Infrastructure - Artifacts
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getTenantConnectorConfigurations
      summary: Get a tenant wide app connector configuration
  /api/configurations/packing:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingConfigurations'
          description: Central Configuration of all packing related things
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      operationId: getPackingConfigurations
      summary: Get the packing configurations
    patch:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: upsertPackingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingConfigurations'
        description: create/update packing central configuration
        required: true
      summary: Change the tenant wide packing central configuration
  /api/configurations/handover:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getHandoverConfiguration
      summary: Read handover configuration
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverConfiguration'
          description: The handover configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: upsertHandoverConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverConfigurationForCreate'
        description: Desired HandoverConfiguration
        required: true
      summary: Change the handover configuration
  /api/configurations/handover/refusereasons:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AvailableRefusedReason'
          description: Existing refuse reasons
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Handover
      description: ''
      operationId: getAllRefuseReasons
      summary: Get all tenant wide refuse reasons
  /api/configurations/tags/packjob:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJobTagConfiguration'
          description: Packjob tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackJobTagConfiguration
      summary: Read tag configuration for the specified section
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackJobTagConfiguration'
          description: The packing configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: putPackJobTagConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobTagConfiguration'
        description: Desired PackJobTagConfiguration
        required: true
      summary: Change the tag configuration for packjobs
  /api/configurations/tags/parcel:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelTagConfiguration'
          description: tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Shipments
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getParcelTagConfiguration
      summary: Read tag configuration for parcels
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelTagConfiguration'
          description: The tag configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: putParcelTagConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelTagConfigurationForUpsert'
        description: Desired Tag Configuration for Parcels
        required: true
      summary: Change the tag configuration for Parcels
  /api/configurations/tags/handoverjob:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverJobTagConfiguration'
          description: handoverJob tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: ''
      operationId: getHandoverJobTagConfiguration
      summary: Read tag configuration for handoverJobs
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoverJobTagConfiguration'
          description: The handoverjob tag configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Handover
      description: ''
      operationId: putHandoverTagConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverJobTagConfiguration'
        description: Desired Tag Configuration for HandoverJobs
        required: true
      summary: Change the tag configuration for HandoverJobs
  /api/configurations/tags/order:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderTagConfiguration'
          description: order tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - DOMS - Orders
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getOrderTagConfiguration
      summary: Read tag configuration for orders
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderTagConfiguration'
          description: The order tag configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      description: ''
      operationId: putOrderTagConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderTagConfiguration'
        description: Desired Tag Configuration for orders
        required: true
      summary: Change the tag configuration for orders
  /api/configurations/domain:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainConfiguration'
          description: Domain config could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Infrastructure - Artifacts
      description: ''
      operationId: getDomainConfiguration
      summary: Get default authentication domain of the tenant
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Infrastructure - Artifacts
      description: ''
      operationId: putDomainConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainConfiguration'
        description: Desired domain note configuration to create/update
        required: true
      summary: Change the tenant's default authentication domain configuration
  /api/configurations/fulfillmentprocessbuffer:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getFulfillmentProcessBufferConfiguration
      summary: Get a tenant fulfillment process buffer configuration
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
          description: Configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putFulfillmentProcessBufferConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
        required: true
      summary: Update fulfillment process buffer configuration of a tenant
  /api/configurations/gdpr:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Gdpr configuration not found
      tags:
        - Core - Configuration
      description: ''
      operationId: getGdprConfiguration
      summary: Get a tenant gdpr config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GdprConfiguration'
          description: Gdpr configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Gdpr configuration not found
      tags:
        - Core - Configuration
      description: ''
      operationId: putGdprConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GdprConfiguration'
        required: true
      summary: Update gdpr configuration of a tenant
  /api/configurations/loadunit:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: getLoadUnitConfiguration
      summary: Get the load unit configuration
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putLoadUnitConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitConfiguration'
        description: Desired load unit configuration to create/update
        required: true
      summary: Change the tenant wide load unit configuration
  /api/configurations/locale:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Configuration
      description: ''
      operationId: getLocaleConfiguration
      summary: Get the tenant wide default locale configuration
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocaleConfiguration'
          description: The locale Configuration was successfully set.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Configuration
      description: ''
      operationId: putLocaleConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocaleConfiguration'
        description: Desired default locale configuration to put
        required: true
      summary: Change the tenant wide default locale configuration
  /api/configurations/oidcproviders:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviders'
          description: existing oidc providers.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Infrastructure - OIDC Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Get the available OIDC providers.
      operationId: getOidcProviders
      summary: Get the available OIDC providers.
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedOidcProvider'
          description: Provider was updated successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Infrastructure - OIDC Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Create an OIDC provider.
      operationId: createOidcProvider
      summary: Create an OIDC provider.
  /api/configurations/oidcproviders/{oidcProviderId}:
    get:
      parameters:
        - description: ID of OIDC provider you want to get.
          in: path
          name: oidcProviderId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedOidcProvider'
          description: Provider was found
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Infrastructure - OIDC Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getOidcProvider
      summary: Get OIDC provider by id.
    put:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OidcProviderForUpdate'
      parameters:
        - description: ID of OIDC provider you want to update.
          in: path
          name: oidcProviderId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OidcProviderForUpdate'
          description: Provider was updated successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Infrastructure - OIDC Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Update an OIDC Provider.
      operationId: updateOidcProvider
      summary: Update an OIDC Provider.
    delete:
      parameters:
        - description: ID of the OIDC provider you want to delete.
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: OIDC Provider not found
      tags:
        - Infrastructure - OIDC Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Delete an OIDC Provider.
      operationId: deleteOidcProvider
      summary: Delete an OIDC Provider.
  /api/configurations/pickingtimes:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultPickingTimesConfiguration'
          description: Picking Times config found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getDefaultPickingTimesConfiguration
      summary: Get the current configuration for tenant wide default picking times
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultPickingTimesConfiguration'
          description: The default picking times configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Configuration version conflict
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putDefaultPickingTimesConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultPickingTimesConfiguration'
        description: Desired default picking times configuration to create/update
        required: true
      summary: Change the tenant wide default picking times configuration
  /api/configurations/returnnote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Shipments
      operationId: getReturnNoteConfiguration
      summary: Get defined return notes of the tenant
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: putReturnNoteConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnNoteConfigurationForUpsert'
        description: Desired return note configuration to create/update
        required: true
      summary: Change the tenant wide return note configuration
  /api/configurations/stock:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockConfiguration'
          description: StockConfiguration config found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Inventory Management - Stocks
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getStockConfiguration
      summary: Get the current stock configuration
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockConfiguration'
          description: The stockConfiguration was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Inventory Management - Stocks
      description: ''
      operationId: putStockConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockConfiguration'
        description: Desired stock configuration to put
        required: true
      summary: Change the tenant wide stock configuration
  /api/configurations/substitution:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubstitutionConfiguration'
          description: Substitution config found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getSubstitutionConfiguration
      summary: Get the current configuration for substitution
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putSubstitutionConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubstitutionConfiguration'
        description: Desired substitution configuration to create/update
        required: true
      summary: Change the tenant wide substitution configuration
  /api/configurations/supportedlocales:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Configuration
      description: ''
      operationId: getLocales
      summary: Get the list of supported locales
  /api/configurations/packing/containerrequired:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated, will be replaced with /api/configurations/packing
      deprecated: true
      operationId: getPackingContainerRequirement
      summary: Get the packing container requirement configuration
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated, will be replaced with /api/configurations/packing
      deprecated: true
      operationId: putPackingContainerRequirement
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingContainerRequiredConfiguration'
        description: Validation picking scan code to activate/deactivate
        required: true
      summary: Change the tenant wide packing container requirement configuration
  /api/deliverynotes:
    post:
      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
      responses:
        '201':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/DeliveryNote'
          description: Successfully created the delivery note.
        '401':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      operationId: createDeliveryNote
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryNote'
        required: true
      summary: Create delivery note
  /api/facilities:
    get:
      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:
            type: array
            items:
              type: string
        - 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'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedFacilities'
          description: Facilities are found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Facilities
      description: ''
      operationId: getAllFacilities
      summary: Return all facilities
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facility'
          description: >-
            The facility was successfully created. The Location header contains
            the URL of the facility.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Facilities
      description: ''
      operationId: addFacility
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityForCreation'
        description: Representation that describes the facility
        required: true
      summary: Add a new facility
  /api/facilities/{facilityId}:
    delete:
      parameters:
        - description: ID of facility you want to delete
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: ''
      operationId: deleteFacility
      summary: deletes a facility with the given ID
    get:
      parameters:
        - description: ID of facility you want to get
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facility'
          description: >-
            Facility was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: ''
      operationId: getFacility
      summary: Get a facility with the given ID
    patch:
      parameters:
        - description: ID of facility you want to patch
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facility'
          description: >-
            Facility was found & patch-set has been applied. The patched
            facility is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      tags:
        - Core - Facilities
      description: ''
      operationId: patchFacility
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityPatchActions'
        description: Patch set
        required: true
      summary: Patches a facility with the given ID
  /api/facilities/{facilityId}/actions:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityActionsParameter'
      parameters:
        - description: Reference to the facility you want to call the action for
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Facility'
          description: Updated Facility in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Facilities
      operationId: facilityAction
      summary: Call a single action on a given facility
  /api/facilities/{facilityId}/carriers:
    get:
      parameters:
        - description: ID of facility you want to get
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedCarriers'
          description: >-
            Carriers are found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: Carriers not found
      tags:
        - Core - Facilities
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getFacilityCeps
      summary: Get the available CEPs for a facility
  /api/facilities/{facilityId}/configurations/stock:
    get:
      parameters:
        - description: ID of facility you want to retrieve the configurations for
          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.
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: No active configurations found for this facility
      tags:
        - Inventory Management - Stocks
      operationId: getFacilityStockConfiguration
      summary: >-
        Gets the facility's current configuration for stock related order
        distribution
    patch:
      parameters:
        - description: ID of facility you want to get
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility Configuration not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      tags:
        - Inventory Management - Stocks
      description: ''
      operationId: patchFacilityConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockConfigurationPatchActions'
        description: Patch set
        required: true
      summary: Patches a facility configuration with the given ID
  /api/facilities/{facilityId}/listings:
    get:
      parameters:
        - description: ID of facility you want to get listing
          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
          in: query
          name: tenantArticleIds
          required: false
          explode: false
          schema:
            type: array
            maxItems: 500
            items:
              type: string
        - 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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Listings
      description: ''
      operationId: getFacilityListing
      summary: Get a facility with the given ID
    put:
      parameters:
        - description: ID of facility you want to put listings to
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ListingBulkOperationResult'
          description: >-
            Facility listing was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Core - Listings
      description: >-
        Bulk PUT for Listings. Please note: This endpoint has legacy behaviour,
        i.e. all PUTs fail if a single PUT fails.
      operationId: putFacilityListing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingsForReplacement'
        description: listings for put
        required: true
      summary: Create or Update listings of a facility with the given ID
    delete:
      parameters:
        - description: ID of facility you want to delete all listings of
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Facility listings were found and successfully deleted
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Core - Listings
      description: ''
      operationId: deleteListingsOfFacility
      summary: deletes all listings of a facility with the given ID
  /api/facilities/{facilityId}/listings/{tenantArticleId}:
    delete:
      parameters:
        - description: ID of facility you want to delete a listing of
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Core - Listings
      description: ''
      operationId: deleteFacilityListing
      summary: deletes a listing with the given ID of a facility with the given ID
    get:
      parameters:
        - description: ID of facility you want to get listing
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Listings not found
      tags:
        - Core - Listings
      description: ''
      operationId: getListing
      summary: Get a Listings with the given ID
    patch:
      parameters:
        - description: ID of facility you want to patch a listing of
          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
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Listing version conflict
      tags:
        - Core - Listings
      description: ''
      operationId: patchFacilityListing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingPatchActions'
        description: listings for put
        required: true
      summary: Update a listing with the given ID of a facility with the given ID
  /api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks:
    get:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
      parameters:
        - description: ID of facility you want to get the partial stocks
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility or Listing not found
      tags:
        - Core - Listings
      operationId: getFacilityListingPartialStock
      summary: Get a partial stocks for a listing
    put:
      deprecated: true
      description: >
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.

        Replaces the current partial stock object related to its listing
      parameters:
        - description: ID of facility you want to get listing
          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 update it.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Core - Listings
      operationId: putFacilityListingPartialStock
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartialStocksForReplacement'
        description: Patch set
        required: true
      summary: Replace partial stocks of a listings of a facility with the given ID
    patch:
      deprecated: true
      description: >
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><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.
      parameters:
        - description: ID of facility you want to patch the partial stocks
          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 update it.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Core - Listings
      operationId: patchFacilityListingPartialStock
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartialStockPatchActions'
        description: Patch set
        required: true
      summary: Patches partial stocks of a listings of a facility with the given ID
    delete:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />This endpoint is deprecated. Use /api/stocks endpoints instead.
      parameters:
        - description: ID of facility from whom you want to delete the partial stock
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Core - Listings
      operationId: deleteFacilityListingPartialStock
      summary: Delete partial stocks of a listings of a facility with the given ID
  /api/validations/postalcodes:
    post:
      responses:
        '200':
          description: The given postal code is valid for the given country
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: The given postal code is invalid for the given country
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '422':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: The given country can't be validated
      tags:
        - Core - Validations
      description: ''
      operationId: validatePostalCode
      summary: Validate a given postal code for a given country
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostalCodeValidation'
        description: Branding object
        required: true
  /api/features:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Features'
          description: The available feature for all active modules
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Infrastructure - Features
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getFeatures
      summary: Returns all features grouped by active modules
  /api/features/{featureName}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Infrastructure - Features
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getFeature
      summary: Returns a feature
    patch:
      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: >-
            Module was found & patch-set has been applied. The patched entity is
            in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Infrastructure - Features
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: patchFeature
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeaturePatchActions'
        description: Patch set
        required: true
      summary: Patches a feature
  /api/pickruns:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: addPickRun
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunForCreation'
        required: true
      summary: Add a new PickRun
  /api/pickruns/{pickRunId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getPickRun
      summary: Return a PickRun
    patch:
      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: The updated PickRun.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Version conflict
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: patchPickRun
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunPatchAction'
        required: true
  /api/pickruns/{pickRunId}/pickjobs:
    patch:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: patchPickRunPickJobs
      summary: Update pick jobs of a pick run
  /api/pickruns/{pickRunId}/actions:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickRunActionsParameter'
      parameters:
        - description: Reference to the pick run you want to call the action for
          in: path
          name: pickRunId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickRun'
          description: Updated Pick Run in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: pickRunAction
      summary: Call a single action on a given pickRun
  /api/handoverjobs:
    get:
      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 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:
            type: array
            items:
              type: string
        - 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: 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:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: End date range for pick jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedHandoverjobs'
          description: Handoverjobs are found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Handover
      description: ''
      operationId: getAllHandoverjobs
      summary: Return all handoverjobs
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Handover
      operationId: addHandoverjob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverjobForCreation'
        required: true
      summary: Add a new handoverjob
  /api/handoverjobs/{handoverjobId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: ''
      operationId: getHandoverjob
      summary: Get a Handoverjob with the given ID
    patch:
      parameters:
        - description: ID of handoverjob you want to patch
          in: path
          name: handoverjobId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Handover
      description: ''
      operationId: patchHandoverjob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverjobPatchActions'
        description: Patch set
        required: true
      summary: Patches a handoverjob with the given ID
  /api/handoverjobs/{handoverJobId}/actions:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverJobActionsParameter'
      parameters:
        - description: Reference to the handover job you want to call the action for
          in: path
          name: handoverJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Handoverjob'
          description: Updated Handover job in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Handover
      operationId: handoverJobAction
      summary: Call a single action on a given Handover job
  /api/loadunits:
    delete:
      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 are successfully deleted.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '422':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: LoadUnits could not be removed due to failing conditions
      tags:
        - Fulfillment Operations - Picking
      operationId: deleteLoadUnits
      summary: Delete loadunits by pickJobRef
    get:
      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
            type: integer
        - description: query load units with the given pickJobRef
          in: query
          name: pickJobRef
          required: false
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the routing
            configuration. 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/LoadUnits'
          description: Load units are found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: getAllLoadUnits
      summary: Return all load units
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnits'
          description: Load units are successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: addLoadUnit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitsForCreation'
        description: Representation that describes the unit load
        required: true
      summary: Add new load units
  /api/loadunits/{loadUnitId}:
    delete:
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnit'
          description: Successfully deleted load unit.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: deleteLoadUnit
      summary: Delete load unit
    get:
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the routing
            configuration. 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/LoadUnit'
          description: The found load unit.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: getLoadUnitByID
      summary: Get a loadUnit by its ID
    patch:
      parameters:
        - in: path
          name: loadUnitId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the routing
            configuration. 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/LoadUnit'
          description: The found load unit.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: patchLoadUnitByID
      summary: Patch a loadUnit by its ID
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/LoadUnitPatchActions'
                - $ref: '#/components/schemas/LoadUnit'
        required: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />LoadUnitPatchActions: Deprecated - For future usage please use
        the /actions endpoints mentioned in the corresponding PatchActions

        LoadUnit: Partial Patch on this entity.
      deprecated: true
  /api/loadunits/{loadUnitId}/stack:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: getStackForLoadUnit
      summary: Get the stack of this load unit by its ID
  /api/loadunittypes:
    get:
      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: >-
            Provide the localized names and descriptions for the routing
            configuration. 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/LoadUnitTypes'
          description: All load unit types.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: getLoadUnitTypes
      summary: Get all load unit types, use operative container types
      deprecated: true
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: Successfully created resource.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: createLoadUnitTypes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitTypeForCreation'
        required: true
      summary: Create new load unit type, use operative container types
      deprecated: true
  /api/loadunittypes/{loadUnitTypeId}:
    get:
      parameters:
        - in: path
          name: loadUnitTypeId
          required: true
          schema:
            type: string
        - description: >-
            Provide the localized names and descriptions for the routing
            configuration. 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/LoadUnitType'
          description: The found load unit type.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: getLoadUnitTypeByID
      summary: Get a loadUnitType by its ID, use operative container types
      deprecated: true
    patch:
      parameters:
        - in: path
          name: loadUnitTypeId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadUnitType'
          description: Successfully updated load unit type.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: updateLoadUnitType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadUnitTypePatchActions'
        description: Patch set
        required: true
      summary: Update load unit type, use operative container types
      deprecated: true
  /api/loadunittypes/{loadUnitTypeId}/icon:
    put:
      parameters:
        - in: path
          name: loadUnitTypeId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: uploadLoadUnitTypeIcon
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NamedFile'
        description: Base64 encoded icon to upload
        required: true
      summary: Upload icon for load unit type, use operative container types
      deprecated: true
  /api/measurementunits:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Listings
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getAllMeasurementUnits
      summary: Get all measurementUnits
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementUnit'
          description: Successfully created the measurementUnit.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Listings
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: createMeasurementUnit
      requestBody:
        $ref: '#/components/requestBodies/MeasurementUnitForCreation'
      summary: Create measurementUnit
  /api/measurementunits/{measurementUnitId}:
    delete:
      parameters:
        - in: path
          name: measurementUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted the measurementUnit.
        '401':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Listings
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: deleteMeasurementUnit
      summary: Delete measurementUnit
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Listings
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getMeasurementUnitByID
      summary: Get a measurementUnit by its ID
    put:
      parameters:
        - in: path
          name: measurementUnitId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeasurementUnit'
          description: Successfully updated the measurementUnit.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Listings
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: updateMeasurementUnit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MeasurementUnitForCreation'
        required: true
      summary: Update measurementUnit
  /api/parcels:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: getAllParcels
      summary: Return all parcels
  /api/parcels/{parcelId}:
    delete:
      parameters:
        - description: ID of the parcel you want to delete
          in: path
          name: parcelId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Parcel was successfully deleted
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: deleteParcel
      summary: Delete a parcel with the given ID
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: getParcel
      summary: Get a parcel with the given ID
    patch:
      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: Successfully updated the parcel.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: patchParcel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelPatchActions'
        description: Patch set
        required: true
      summary: Patches a parcel with the given ID
  /api/parcels/{parcelId}/labels/{labelDocument}:
    get:
      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: all.pdf, send.pdf and return.pdf
            = Parcel label plus (if configured) retoure label.
          in: path
          name: labelDocument
          required: true
          schema:
            enum:
              - return.pdf
              - all.pdf
              - send.pdf
              - customs.pdf
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: getLabelForParcel
      summary: Get a label for the parcel with the given ID
  /api/parcels/{parcelId}/deliverynote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Parcel not found
      tags:
        - Fulfillment Operations - Shipments
      operationId: getParcelDeliveryNote
      summary: Get deliveryNote for a parcel
  /api/parcels/{parcelId}/returnnote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Parcel not found
      tags:
        - Fulfillment Operations - Shipments
      operationId: getParcelReturnNote
      summary: Get returnNote for a parcel
  /api/pickjobs:
    get:
      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:
              type: string
              maxItems: 100
            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 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:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: End date range for pick jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: Reference to pickjobs
          explode: false
          in: query
          name: pickJobRefs
          required: false
          schema:
            items:
              type: string
              maxItems: 100
            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.
        '204':
          description: No PickJobs were found as a result to the given query.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: queryPickJobs
      summary: Simple query interface to find pickjobs
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: addPickJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobForCreation'
        description: Pick job object
        required: true
      summary: Add a new pick job for fulfillment
  /api/documents/{documentId}/file:
    get:
      parameters:
        - in: path
          name: documentId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The document with given id
      tags:
        - Core - Processes
      description: ''
      operationId: downloadProcessDocument
      summary: Download a document
  /api/documentSet/{documentSetRef}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Document Sets
      operationId: getDocumentSetDeprecated
      summary: Simple query interface to find documents
      deprecated: true
      description: Deprecated, use /api/documentsets/{documentSetRef} instead
  /api/documentSet/{documentSetRef}/documents:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Document Sets
      operationId: addDocumentDeprecated
      deprecated: true
      description: Deprecated, use /api/documentsets/{documentSetRef}/documents instead
  /api/documentSet/{documentSetRef}/documents/{documentRef}:
    patch:
      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'
        description: PartialDocument
        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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Document Sets
      operationId: updateDocumentDeprecated
      summary: Simple query interface to find documents
      deprecated: true
      description: >-
        Deprecated, use
        /api/documentsets/{documentSetRef}/documents/{documentRef} instead
  /api/documentSet/{documentSetRef}/documents/{documentRef}/file:
    get:
      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
      tags:
        - Core - Document Sets
      description: ''
      operationId: downloadDocumentDeprecated
      summary: Download a document
    put:
      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'
        description: Document Content with id and version
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Changed Document
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Document Sets
      operationId: addContentToDocumentDeprecated
      deprecated: true
      description: >-
        Deprecated, use
        /api/documentsets/{documentSetRef}/documents/{documentRef}/file instead
  /api/documentsets/{documentSetRef}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Document Sets
      operationId: getDocumentSet
      description: ''
      summary: Simple query interface to find documents
  /api/documentsets/{documentSetRef}/documents:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Document Sets
      operationId: addDocument
  /api/documentsets/{documentSetRef}/documents/{documentRef}:
    patch:
      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'
        description: PartialDocument
        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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Document Sets
      operationId: updateDocument
      summary: Simple query interface to find documents
  /api/documentsets/{documentSetRef}/documents/{documentRef}/file:
    get:
      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
      tags:
        - Core - Document Sets
      description: ''
      operationId: downloadDocument
      summary: Download a document
    put:
      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'
        description: Document Content with id and version
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrintableDocument'
          description: Changed Document
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Document Sets
      operationId: addContentToDocument
  /api/pickjobs/{pickJobId}/actions:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobActionsParameter'
      parameters:
        - description: Reference to the pick job you want to call an action for
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJob'
          description: Updated PickJob in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: pickJobAction
      summary: Call a single action on a given pickJob
  /api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: queryPickLineItemsSubstitutes
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/pickjobs/{pickJobId}/loadunits:
    get:
      parameters:
        - description: >-
            Reference to the pick job you want to get the corresponding
            loadunits
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      operationId: queryPickJobLoadUnits
      summary: Simple query interface to find load units of a pickjob
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickingLoadUnit'
          description: The load units was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: addPickJobLoadUnits
      parameters:
        - description: >-
            Reference to the pick job you want to get the corresponding
            loadunits
          in: path
          name: pickJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickingLoadUnitForCreation'
        description: Pick job load unit object
        required: true
      summary: Add a new load unit for pick job
  /api/pickjobs/{pickJobId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getPickJob
      summary: Get a pick job with the given ID
    patch:
      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 & patch-set has been applied. The patched pick job
            is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: PickJob not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: PickJob version conflict
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: patchPickJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickingPatchActions'
        description: Patch set
        required: true
      summary: Patches a pick job with the given ID
  /api/pickjobs/{pickjobId}/returnnote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getReturnNotesForPickjob
      summary: Get the return note for the pickjob with the given ID
  /api/pickjobs/{pickJobId}/deliverynote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getPickJobDeliveryNote
      summary: Get a deliverynote for the pick job with the given ID
  /api/process:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: The given parameters are invalid
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getProcesses
      summary: >-
        Returns a process belonging to the given parameters. At least one
        parameter needs to be supplied.
  /api/processes:
    get:
      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:
            type: array
            items:
              type: string
        - description: >-
            Reference to the operativeStatus you want to get the corresponding
            processes
          explode: true
          in: query
          name: operativeStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: Perform full text search base on the tenantOrderId
          in: query
          name: tenantOrderId
          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:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: >-
            Return the Processes which have related pickjobs with a targettime
            on or before this date
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: Return the Processes created on or after this date
          in: query
          name: startDate
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: Return the Processes created on or before this date
          in: query
          name: endDate
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: Id's of the facilities from which you want to get the processes
          explode: true
          in: query
          name: facilityRefs
          required: false
          schema:
            type: array
            items:
              type: string
        - 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:
            type: array
            items:
              type: string
        - description: Consumer country codes from which you want to get the processes
          explode: true
          in: query
          name: countries
          required: false
          schema:
            type: array
            items:
              type: string
        - description: Facility country codes from which you want to get the processes
          explode: true
          in: query
          name: facilityCountries
          required: false
          schema:
            type: array
            items:
              type: string
        - description: Brand ids for which you want to get the processes
          explode: true
          in: query
          name: brandRefs
          required: false
          schema:
            type: array
            items:
              type: string
        - description: Order delivery preferences service level
          explode: true
          in: query
          name: serviceLevels
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - DELIVERY
                - SAMEDAY
        - description: Whether an order is click and collect or delivery
          explode: true
          in: query
          name: serviceTypes
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - COLLECT
                - SHIPPING
        - description: >-
            Reference to the orderDomainStatus you want to get the corresponding
            processes
          explode: true
          in: query
          name: orderDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the routingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: routingDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the pickingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: pickingDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the packingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: packingDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the shippingDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: shippingDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the handoverDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: handoverDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the returnDomainStatus you want to get the
            corresponding processes
          explode: true
          in: query
          name: returnDomainStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: Stickers attached to a order
          explode: true
          in: query
          name: stickers
          required: false
          schema:
            type: array
            items:
              type: string
        - 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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getAllProcesses
      summary: Return all processes
  /api/processes/retrynotroutable:
    post:
      responses:
        '204':
          description: >-
            The retry for all not routable proceses has been succesfully
            triggered
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: The retry task can not be triggered due to a conflicting operation
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Processes
      description: ''
      operationId: triggerRetryNotRoutable
      summary: triggers the retry of not routable plans
  /api/processes/{processId}:
    patch:
      parameters:
        - description: ID of process you want to patch
          in: path
          name: processId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Process not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Process version conflict
      tags:
        - Core - Processes
      description: ''
      operationId: patchProcess
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessPatchActions'
        description: Patch set
        required: true
      summary: Patches a process with the given ID
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getProcessByID
      summary: Get a process by its ID
  /api/processes/{processId}/reroute:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Process not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Process version conflict
      tags:
        - Core - Processes
      description: ''
      operationId: postProcess
      summary: Reroutes a process with the given ID
  /api/processes/{processId}/documents:
    post:
      parameters:
        - in: path
          name: processId
          required: true
          schema:
            type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalDocument'
          description: The document was successfully created
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDocumentForCreation'
        description: ''
        required: true
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: addDocumentToProcess
      summary: Create a new document on this process
  /api/processes/{processId}/documents/{documentId}/file:
    get:
      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
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: downloadDocumentInProcess
      summary: Read a document on this process
    put:
      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 was successfully updated
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalDocumentForUpdate'
        description: ''
        required: true
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: updateDocumentInProcess
      summary: Update a document on this process
  /api/processes/{processId}/documents/{documentId}:
    get:
      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
      tags:
        - Core - Processes
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: readDocumentMetaInProcess
      summary: Read meta information about document on this process
  /api/returns:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnJobs'
          description: Return Jobs that were found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Returns
      operationId: getReturnJobs
      parameters:
        - description: all entities after given Id
          in: query
          name: startAfterId
          required: false
          schema:
            type: string
        - description: number of entities to show (max 500 per request)
          in: query
          name: size
          required: false
          schema:
            default: 25
            type: integer
        - description: Reference to the facility you want to filter for
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: >-
            Reference to the status you want to get the corresponding return
            jobs to
          in: query
          name: status
          required: false
          schema:
            items:
              type: string
            type: array
      summary: Get Return Jobs
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnJob'
          description: The return was successfully created
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Returns
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />
      deprecated: true
      operationId: addReturn
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnJobForCreation'
        description: 'ReturnJob object '
        required: true
      summary: Add a new return
  /api/returns/{returnId}:
    get:
      parameters:
        - description: ID of the return you want to get
          in: path
          name: returnId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnJob'
          description: >-
            Return was found & you were allowed to access it. The result is in
            the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Fulfillment Operations - Returns
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Will be replaced in the future with the new /itemreturnjob.
      deprecated: true
      operationId: getReturnLines
      summary: Get return with the given return ID
    patch:
      parameters:
        - description: ID of return you want to patch
          in: path
          name: returnId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnJob'
          description: >-
            Return was found & patch-set has been applied. The patched entity is
            in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Returns
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />
      operationId: patchReturn
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnPatchActions'
        description: Patch set
        required: true
      summary: Patches a return with the given ID
      deprecated: true
  /api/scopedcapabilities:
    get:
      parameters:
        - description: id of the facility
          in: query
          name: facilityId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedCapabilities'
          description: All ScopedCapabilities whic are at least inactive
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Infrastructure - Features
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getCapabilities
      summary: >-
        Returns all scopedcapabilities which are at least inactive and available
        to a facility/user
  /api/shipments:
    get:
      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: 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:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: End date range for shipments
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - 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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: getAllShipments
      summary: Return all shipments
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      operationId: addShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentForCreation'
        description: Shipment object supplied by your picking app
        required: true
      summary: Add a new Shipment
  /api/shipments/{shipmentId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Shipment not found
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: getShipment
      summary: Get a Shipment with the given ID
    patch:
      parameters:
        - description: ID of shipment you want to patch
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: patchShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShipmentPatchActions'
        description: Patch set
        required: true
      summary: Patches a shipment with the given ID
  /api/shipments/{shipmentId}/deliverynote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Shipment not found
      tags:
        - Fulfillment Operations - Shipments
      operationId: getShipmentDeliveryNote
      summary: Get delivery note for a shipment
  /api/shipments/{shipmentId}/parcels:
    post:
      parameters:
        - description: ID of shipment you want to create parcel for
          in: path
          name: shipmentId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '422':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Parcel could not be processed due to failing conditions
      tags:
        - Fulfillment Operations - Shipments
      description: ''
      operationId: addParcel
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelForCreation'
        description: Payload of the parcel you want to create
      summary: Creates a new parcel for a shipment
  /api/status:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: The status result
      tags:
        - Infrastructure - Health
      description: ''
      operationId: status
      summary: A public status endpoint that renders general availability information
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels:
    post:
      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:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParcelForCreation'
        description: Payload of the parcel you want to create
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Parcel'
          description: Create a parcel for an itemReturn
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createItemReturnParcel
      summary: Create a parcel for an itemReturn
  /api/subscriptions:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Eventing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getSubscriptions
      summary: Get all subscriptions
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
          description: Subscription is successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Eventing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: addSubscription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionForCreation'
        description: Representation that describes the subscription
        required: true
      summary: >-
        Add new Subscription. Please note: Currently it is only possible to add
        one subscription per event.
  /api/subscriptions/{subscriptionId}:
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Eventing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: deleteSubscription
      summary: Delete subscription by Id
  /api/substitutes:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Fulfillment Operations - Picking
      operationId: getResultingSubstitutesForTenantArticleId
      summary: Get the resulting substitutes for a specific tenantArticleId.
  /api/substitutes/{tenantArticleId}:
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: deleteSubstitutesForTenantArticleId
      summary: deletes substitutes for the given tenant article id
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Fulfillment Operations - Picking
      description: Get the substitutes for a given tenant article id
      operationId: getSubstitutesForTenantArticleId
      summary: Get the substitutes for a given tenant article id
    put:
      parameters:
        - description: Tenant article ID of the article the substitutes should be set for
          in: path
          name: tenantArticleId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Substitutes'
          description: The substitutes for tenantArticleId were successfully updated
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility listing not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putSubstitutesForTenantArticleID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubstitutesForUpsert'
        description: substitutes to set
        required: true
      summary: Set possible substitutes for a tenant article ID
  /api/supportedevents:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportedEvents'
          description: All supported events.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Eventing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getEvents
      summary: Get a list of supported events you can subscribe to.
  /api/users:
    get:
      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: query users orderBy
          in: query
          name: orderBy
          required: false
          schema:
            $ref: '#/components/schemas/UserOrderBy'
        - description: filter by facility id
          in: query
          name: facilityId
          required: false
          schema:
            type: string
        - description: include admin users without a facility
          in: query
          name: includeAdminUsers
          required: false
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedUsers'
          description: User are found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - User Management
      description: ''
      operationId: getAllUsers
      summary: Return all users
    post:
      responses:
        '201':
          description: The user is successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - User Management
      description: ''
      operationId: createUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserForCreation'
        description: User object
        required: true
      summary: Create a new user
  /api/users/branding/{clientName}:
    put:
      parameters:
        - description: Identifier for the client you want to set the branding for.
          in: path
          name: clientName
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The branding was successfully set.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Unknown clientName
      tags:
        - Core - User Management
      operationId: putBranding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Branding'
        description: Branding object
        required: true
      summary: 'Sets the branding '
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated, will be replaced by /api/configurations/tenant
  /api/users/sign/transloadit/{templateId}:
    get:
      parameters:
        - description: The id of the template to sign the request
          in: path
          name: templateId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The signed request is returned.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - User Management
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated, image upload is no longer supported
      operationId: signTransloaditRequest
      summary: Sign an upload request for a given template
  /api/users/{userId}:
    delete:
      parameters:
        - description: user ID of the user you want to delete
          in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User was found and successfully deleted
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Core - User Management
      description: ''
      operationId: deleteUser
      summary: Deletes a User with the given ID
    get:
      parameters:
        - description: ID of User you want to get
          in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: >-
            User was found & you were allowed to access it. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Core - User Management
      description: ''
      operationId: getUser
      summary: Get a User with the given ID
    patch:
      parameters:
        - description: ID of the user you want to patch
          in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
          description: The user is successfully modified.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility version conflict
      tags:
        - Core - User Management
      description: ''
      operationId: patchUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPatchActions'
        description: ModifyUser object
        required: true
      summary: Patch an existing user with the given ID
  /api/users/{userId}/permissions:
    get:
      parameters:
        - description: ID of User you want to get
          in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Roles'
          description: >-
            User was found & you were allowed to access it. The result is in the
            body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Core - User Management
      description: ''
      operationId: getUserRoles
      summary: Get a User with the given ID
  /api/users/{userId}/assignedFacilities:
    post:
      parameters:
        - description: ID of User you want to assign a facility
          in: path
          name: userId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The facility was correctly assigned
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAssignedFacilityForCreation'
        description: The facility you want to assign the user
        required: true
      tags:
        - Core - User Management
      description: ''
      operationId: postAssignedFacilities
      summary: Assigns a facility to an user
  /api/users/{userId}/assignedFacilities/{assignedFacilityId}:
    delete:
      parameters:
        - description: User ID from whom you want to delete the facility
          in: path
          name: userId
          required: true
          schema:
            type: string
        - description: Facility id you want to delete from the user
          in: path
          name: assignedFacilityId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The assigned facility was correctly removed from the user.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Core - User Management
      description: ''
      operationId: deleteAssignedFacilities
      summary: Removes an assigned facility from the user
  /api/brands:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Processes
      description: ''
      operationId: getAllBrands
      summary: Return all brands
  /api/returnnotes:
    post:
      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
      responses:
        '201':
          content:
            application/pdf:
              schema:
                $ref: '#/components/schemas/ReturnNote'
          description: Successfully created the return note.
        '401':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Shipments
      operationId: createReturnNote
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnNote'
        required: true
      summary: Create return note
  /api/packjobs:
    get:
      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 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 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:
            type: array
            items:
              type: string
        - description: query packjobs orderBy
          in: query
          name: orderBy
          required: false
          schema:
            type: string
        - description: Start date range for pack jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: End date range for pack jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackJobs
      summary: Get all pack jobs
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: addPackJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobForCreation'
        description: Pack job object
        required: true
      summary: Add a new pack job
  /api/packingcontainertypes:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: addPackingContainerType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingContainerTypeForCreation'
        description: Packing type object
        required: true
      summary: Add a new packing container type, use operative container types
      deprecated: true
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackingContainerTypes
      summary: Get all packing container types, use operative container types
      deprecated: true
  /api/packingcontainertypes/{packingContainerTypeId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackingContainerType
      summary: Get a packing container type by its id, use operative container types
      deprecated: true
    patch:
      parameters:
        - description: ID of the packingcontainertype you want to change
          in: path
          name: packingContainerTypeId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: PackingContainerType not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: PackingContainerType version conflict
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: updatePackingContainerType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingContainerTypePatchActions'
        description: Patch set
        required: true
      summary: >-
        Patches a PackingContainerType with the given ID, use operative
        container types
      deprecated: true
  /api/pickjobs/{pickJobId}/documenthandling:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getPickJobDocumentHandling
      summary: Get a pick job document handling information with the given ID
  /api/packingsourcecontainers/{packingSourceContainerId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />Get PackingSourceContainer by ID.
      operationId: getPackingSourceContainerById
      summary: Get a single packingSourceContainer
  /api/packingsourcecontainers:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />Creating new packingSourceContainer.
      operationId: addPackingSourceContainer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingSourceContainerForCreation'
        description: Packing type object
        required: true
      summary: Add a new packingSourceContainer
    get:
      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
            maximum: 500
        - 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:
            type: array
            items:
              type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/PaginatedPackingSourceContainers'
                type: array
          description: Found Packing Source Container
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Listing packingSourceContainer.
      operationId: getPackingSourceContainers
      summary: Get all packingSourceContainers
  /api/packjobs/{packJobId}/documenthandling:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackJobDocumentHandling
      summary: Get a pack job document handling information with the given ID
  /api/packjobs/{packJobId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackJob
      summary: Get a pack job with the given ID
    patch:
      parameters:
        - description: ID of the packjob you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: PackJob not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: PackJob version conflict
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: patchPackJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackJobPatchActions'
        description: Patch set
        required: true
      summary: Patches a pack job with the given ID
  /api/packjobs/{packJobId}/returnnote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getReturnNotesForPackJob
      summary: Get the return note for the packjob with the given ID
  /api/packjobs/{packJobId}/deliverynote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackJobDeliveryNote
      summary: Get a deliverynote for the pack job with the given ID
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/returnnote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/pdf:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getReturnNotesForPackingTargetContainer
      summary: Get the return note for the packingTargetContainer with the given ID
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/deliverynote:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getPackingTargetContainerDeliveryNote
      summary: Get a deliverynote for the packingTargetContainer with the given ID
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getTargetcontainer
      summary: Get a packing target container with the given ID on given packJob
    patch:
      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
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Packing
      operationId: patchTargetcontainer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerPatchActions'
        description: Patch set
        required: true
      summary: Patches a packing container with the given ID
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
    post:
      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
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: The packing container was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: addTargetcontainer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerLineItemForCreation'
        description: Packing Container line item object
        required: true
      summary: Add a new packing container line item
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: deletePackingTargetContainer
      summary: deletes a packing target container with the given ID
  /api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}:
    patch:
      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':
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Patch line item of a packing container
      operationId: patchTargetContainerLineItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerActionsParameter'
        description: Patch set
        required: true
      summary: Patches a packing container with the given ID
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: deleteLineItemTargetContainers
      summary: deletes a lineItem of a packing container with the given ID
  /api/packjobs/{packJobId}/targetcontainers:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getAllTargetcontainers
      summary: Get all packing container on given packJob
    post:
      parameters:
        - description: ID of the pack job you want to get
          in: path
          name: packJobId
          required: true
          schema:
            type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackingTargetContainer'
          description: The packing container was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Packing
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: addTargetContainers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackingTargetContainerForCreation'
        description: Packing Container object
        required: true
      summary: Add a new packing container
  /api/tags:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: No more elements available
      tags:
        - Core - Tags
      description: ''
      operationId: getTags
      summary: Returns all tags
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: The tag was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Tags
      description: ''
      operationId: addTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagForCreation'
        description: Tag object
        required: true
      summary: Add a new tag
  /api/tags/{tagRef}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - Core - Tags
      description: ''
      operationId: getTag
      summary: Get a tag with the given key
    patch:
      parameters:
        - description: Id of the tag you want to update
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Tag not found
      tags:
        - Core - Tags
      description: ''
      operationId: putTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagPatchActions'
        description: Tag patch action
        required: true
      summary: Update a tag with the given key
  /api/tags/packing/needspacking:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Packing
      description: ''
      operationId: getNeedsPacking
      summary: Get packing information for given Tag
  /api/restowitems:
    get:
      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 restoe items
          in: query
          name: restowed
          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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestowedItems'
          description: Restow items were found. The results are in the body.
        '204':
          description: No restow items were found as a result to the given query.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Restow
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: queryRestowItems
      summary: Simple query interface to find restowItems
  /api/restowitems/{restowItemId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Restow
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getRestowItem
      summary: Get a restow item with the given ID
    patch:
      parameters:
        - description: ID of the restow item you want to update
          in: path
          name: restowItemId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: RestowItem not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: RestowItem version conflict
      tags:
        - Fulfillment Operations - Restow
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: patchRestowItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestowItemPatchActions'
        description: Patch set
        required: true
      summary: Patches a restow item with the given ID
  /api/configurations/picking:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickingConfigurations'
          description: Central Configuration of all picking related things
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      operationId: getPickingConfigurations
      summary: Get the picking configurations
    patch:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putPickingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickingConfigurations'
        description: create/update picking central configuration
        required: true
      summary: Change the tenant wide picking central configuration
  /api/configurations/tags/pickjob:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJobTagConfiguration'
          description: pickjob tag config is in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: getPickJobTagConfiguration
      summary: Read tag configuration for pickjobs
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PickJobTagConfiguration'
          description: The packing configuration was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Picking
      description: ''
      operationId: putPickJobTagConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PickJobTagConfiguration'
        description: Desired Tag Configuration for Pickjobs
        required: true
      summary: Change the tag configuration for Pickjobs
  /api/handovercontainers:
    get:
      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
            type: integer
        - description: facilities to filter the results
          in: query
          name: facilityRefs
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StrippedHandoverContainer'
          description: All HandoverContainer matching the given parameters.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Get all Handover Container respecting the given filter
      operationId: getHandoverContainer
      summary: Get Handover Container
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoverContainerForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/HandoverContainer'
          description: Created Handover Container.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Create new Handover Container
      operationId: createHandoverContainer
      summary: Create Handover Container
  /api/handovercontainers/{handoverContainerId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Get Handover Container respecting the given id
      operationId: getHandoverContainerById
      summary: Get Handover Container by id
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Delete Handover Container respecting the given id
      operationId: deleteHandoverContainerById
      summary: Delete Handover Container by id
  /api/handovercontainers/{handoverContainerId}/stack:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Handover
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Get Stack for Handover Container respecting the given id
      operationId: getStackForHandoverContainer
      summary: Get Stack for Handover Container
  /api/stacks:
    get:
      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
            type: integer
        - description: facilities to filter the results
          in: query
          name: facilityRefs
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/StacksResponse'
          description: All Stacks matching the given parameters.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Stacks
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Get all Stacks respecting the given filter
      operationId: getStacks
      summary: Get Stacks
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StackForCreation'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Stack'
          description: Created Stack.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Stacks
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Create new Stack
      operationId: createStack
      summary: Create Stack
  /api/stacks/{stackId}:
    get:
      parameters:
        - description: id of the stack
          in: path
          name: stackId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stack'
          description: Stack matching the given id.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Stacks
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Get Stack respecting the given id
      operationId: getStackById
      summary: Get Stack by id
  /api/remoteconfigs:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Created entity in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Remote Configuration
      operationId: createRemoteConfiguration
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      summary: Create a new remote configuration
    get:
      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: facility to filter to
          in: query
          name: facilityId
          required: false
          schema:
            type: string
        - description: groups to filter to
          in: query
          name: groups
          required: false
          schema:
            type: array
            items:
              type: string
        - description: userId to filter to
          in: query
          name: userId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/RemoteConfiguration'
          description: Central RemoteConfiguration
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Remote Configuration
      operationId: getAllRemoteConfigurations
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      summary: Get all remote configurations
  /api/remoteconfigs/{id}:
    get:
      parameters:
        - description: Reference to the remote config you want to get
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Remote Configuration
      operationId: getRemoteConfiguration
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      summary: Get a single remote configuration
    delete:
      parameters:
        - description: Reference to the remote config you want to delete
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully Deleted
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Remote Configuration
      operationId: deleteRemoteConfiguration
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      summary: Delete a single remote configuration
    patch:
      parameters:
        - description: Reference to the remote config you want to change
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationForUpdate'
      responses:
        '200':
          description: Successfully Changed
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Remote Configuration
      operationId: updateRemoteConfiguration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      summary: Update a single remote configuration
    put:
      parameters:
        - description: Reference to the remote config you want to change
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoteConfigurationForPut'
      responses:
        '200':
          description: Successfully Changed
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Remote Configuration
      operationId: putRemoteConfiguration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      summary: Override a single remote configuration
  /api/remoteconfigs/{id}/scopes:
    post:
      parameters:
        - description: Reference to the remote config you want to change
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRemoteConfigurationScopeParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Updated RemoteConfiguration in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Remote Configuration
      operationId: addRemoteConfigurationScope
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      summary: add a new scope to a remote configuration
  /api/remoteconfigs/{id}/scopes/{scopeId}:
    delete:
      parameters:
        - description: Reference to the remote config you want to alter
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Reference to the remote config scope you want to delete
          in: path
          name: scopeId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoteConfiguration'
          description: Successfully Deleted
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Remote Configuration
      operationId: deleteScopeFromRemoteConfiguration
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      summary: Delete a scope from a given remote configuration
  /api/configurations/return:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalizedReturnConfiguration'
          description: Return config found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getReturnConfiguration
      summary: Get the current configuration for returns
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalizedReturnConfiguration'
          description: The return configuration was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalizedReturnConfiguration'
          description: The return configuration was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Returns
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: upsertReturnConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReturnConfiguration'
        description: Desired return configuration to create/update
        required: true
      summary: Change the tenant wide return configuration
  /api/itemreturns:
    get:
      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: facilities to filter the results
          in: query
          name: facilityRefs
          required: false
          schema:
            type: array
            items:
              type: string
        - description: ItemReturnStatus of an included ItemReturn to filter the results
          in: query
          name: itemReturnStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            ItemReturnLineItemStatus of an included itemReturnLineItem to filter
            the results
          in: query
          name: itemReturnLineItemStatus
          required: false
          schema:
            type: array
            items:
              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/ItemReturn'
          description: All Item Returns matching the given parameters
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: findItemReturns
      summary: Get all Item Returns
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns:
    get:
      parameters:
        - description: item return job to read the item return for
          in: path
          name: itemReturnJobId
          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
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ItemReturn'
          description: Get all item returns for a given item return job
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getItemReturns
      summary: Get item returns
    post:
      parameters:
        - description: Id of the item return job to create the item return for
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Create a new item return for an item return job
      operationId: createItemReturn
      summary: Creates a new ItemReturn
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}:
    get:
      parameters:
        - description: item return job to read the item return for
          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
        - 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:
                $ref: '#/components/schemas/ItemReturn'
          description: Get a specific item return
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getItemReturn
      summary: Get item return by id
    delete:
      parameters:
        - description: id of the item return job to delete the item return for
          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/ItemReturn'
          description: >-
            item return was found and successfully deleted. Updated item return
            job is returned.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Delete an item return from an item return job
      operationId: deleteItemReturn
      summary: Delete an item return from an item return job
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems:
    put:
      parameters:
        - description: id of the item return job the item return belongs to
          in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - description: id of the item return the returned line items belong to
          in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceReturnedLineItems'
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />Replace returned line items of an item return of an item return job.
      operationId: replaceReturnedLineItems
      summary: replace returned line items
  /api/itemreturnjobs:
    get:
      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:
            type: array
            items:
              type: string
        - description: scannableCodes of the item return to filter the results
          in: query
          name: itemReturnScannableCodes
          required: false
          schema:
            type: array
            items:
              type: string
        - description: ItemReturnJobStatus to filter the results
          in: query
          name: itemReturnJobStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - description: ItemReturnStatus of an included ItemReturn to filter the results
          in: query
          name: itemReturnStatus
          required: false
          schema:
            type: array
            items:
              type: string
        - 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: 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/ItemReturnJob'
          description: All Item Return Jobs matching the given parameters
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getItemReturnJobs
      summary: Get all Item Return Jobs
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemReturnJobForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Created entity
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createItemReturnJob
      summary: Creates a new ItemReturnJob
  /api/itemreturnjobs/{itemReturnJobId}:
    get:
      parameters:
        - description: id of the item return job
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getItemReturnJob
      summary: Get Item Return Job by id
  /api/itemreturnjobs/{itemReturnJobId}/actions:
    post:
      parameters:
        - description: id of the Item Return Job
          in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemReturnJobActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated entity
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: updateItemReturnJob
      summary: Updates a new ItemReturnJob
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions:
    post:
      parameters:
        - description: id of the Item Return Job
          in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - description: id of the Item Return
          in: path
          name: itemReturnId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ItemReturnActionsParameter'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated entity
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: itemReturnActions
      summary: Actions for a ItemReturn
  /api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}:
    patch:
      parameters:
        - description: id of the Item Return Job
          in: path
          name: itemReturnJobId
          required: true
          schema:
            type: string
        - description: id of the Item Return
          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'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemReturnJob'
          description: Updated ItemReturnJob
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Returns
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: updateItemReturnLineItem
      summary: Patch for a ItemReturn LineItem
  /api/configurations/expiry:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpiryConfiguration'
          description: config found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getExpiryConfiguration
      summary: Get the current configuration
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - Core - Configuration
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: upsertExpiryConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExpiryConfiguration'
        description: Desired configuration to create/update
        required: true
      summary: Change the tenant wide configuration
  /api/expiries:
    get:
      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:
            type: string
            format: date-time
            example: '2020-02-03T08:45:51.525Z'
        - 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:
                type: array
                items:
                  $ref: '#/components/schemas/ExpiryEntity'
          description: found entities in the result.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Expiries
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getExpiries
      summary: Get expiries by filter parameter
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Expiries
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createExpiry
      summary: Create Expiry
  /api/expiries/{expiryId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Expiries
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getExpiry
      summary: Get Expiry by Id
    patch:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Expiries
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: updateExpiry
      summary: Update Expiry
  /api/externalactions:
    get:
      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:
            type: array
            items:
              type: string
        - 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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: External action not found
      tags:
        - Core - External Actions
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />Returns a list with all external actions.
      operationId: getExternalActions
      summary: Get the external actions related to a process
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalAction'
          description: The external action was successfully created.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: External action not found
      tags:
        - Core - External Actions
      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
      summary: Create an external action
  /api/externalactions/{externalActionId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: External action not found
      tags:
        - Core - External Actions
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />Returns an external action with the given id if found.
      operationId: getExternalAction
      summary: Get an external action
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: External action not found
      tags:
        - Core - External Actions
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: deleteExternalAction
      summary: Delete an external action with the given id.
    put:
      parameters:
        - description: ID of the external action that you want update
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - External Actions
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />Replaces the external action with the provided in the body.
      operationId: putExternalAction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalActionForReplacement'
        description: Updates an external action
        required: true
      summary: Replace an external action
  /api/externalactions/{externalActionId}/logs:
    post:
      parameters:
        - description: ID of the external action you want to create the log for
          in: path
          name: externalActionId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: External action not found
      tags:
        - Core - External Actions
      description: Creates a new external action log.
      operationId: postExternalActionLog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalActionLogForCreation'
        description: The external action log to be created
        required: true
      summary: Creates a log for an external action
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: External action logs not found
      tags:
        - Core - External Actions
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />Returns the logs related with the given external action.
      operationId: getExternalActionLogs
      summary: Get the logs for an external action
  /api/facilities/{facilityId}/carriers/{carrierRef}:
    get:
      parameters:
        - description: ID of facility you want to get listing
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: >-
            The ID that describes the connection of this facility to the
            referenced carrier
          in: path
          name: carrierRef
          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/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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            There is no connection to a carrier with this facility referenced by
            the provided facilityCarrierConnectionId
      tags:
        - Core - Facilities
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getFacilityCarrier
      summary: Get the details for a carrier related to the facility with the given ID
    post:
      parameters:
        - description: ID of facility you want to get
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: The referenced carrier ID
          in: path
          name: carrierRef
          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/FacilityCarrierConnection'
          description: Creation was successful.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            There is no connection to a carrier with this facility referenced by
            the provided facilityCarrierConnectionId.
      tags:
        - Core - Facilities
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: createCarrierToFacility
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCarrierConnectionForCreation'
        description: Representation that describes the facility
        required: true
      summary: >-
        Create a connection of a configured carrier to the facility with given
        ID
    put:
      parameters:
        - description: ID of facility you want to get
          in: path
          name: facilityId
          required: true
          schema:
            type: string
        - description: The referenced carrier ID
          in: path
          name: carrierRef
          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/FacilityCarrierConnection'
          description: Modification was successful.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            There is no connection to a carrier with this facility referenced by
            the provided facilityCarrierConnectionId.
      tags:
        - Core - Facilities
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: connectCarrierToFacility
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCarrierConnectionForModification'
        description: Representation that describes the facility
        required: true
      summary: 'Connect a configured carrier to the facility with given ID '
  /api/health:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Manual reroute configuration not found
      tags:
        - Infrastructure - Health
      description: ''
      operationId: healthCheck
      summary: Do a health check
  /api/facilities/{facilityId}/storagelocations:
    get:
      parameters:
        - description: ID of facility from whom you want to get the storage locations
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: ''
      operationId: getFacilityStorageLocations
      summary: Get the storage locations of this facility
    post:
      parameters:
        - description: ID of facility from whom you want to create the storage location
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StorageLocation'
          description: The storage location was successfully created.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: Creates a new storage location in this facility.
      operationId: postFacilityStorageLocations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationForCreation'
        description: Patch set
        required: true
      summary: Create a new storage location
  /api/facilities/{facilityId}/storagelocations/{storageLocationId}:
    get:
      parameters:
        - description: ID of facility from whom you want to get 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
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: ''
      operationId: getFacilityStorageLocation
      summary: Get the storage location of this facility
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility or storage location not found
      tags:
        - Core - Facilities
      description: ''
      operationId: deleteFacilityStorageLocation
      summary: Delete a storage location of a facility with the given ID
    put:
      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
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility or Storage Location not found
      tags:
        - Core - Facilities
      description: >-
        Replaces the current storage locations of this Facility with the
        provided in the body.
      operationId: putFacilityStorageLocation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationForReplacement'
        description: Patch set
        required: true
      summary: Replace the storage locations of a Facility
    patch:
      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
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility or Storage location not found
      tags:
        - Core - Facilities
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StorageLocationPatchActions'
        description: Patch set
        required: true
      summary: Patches the storage locations of a facility with the given ID
  /api/facilities/{facilityId}/zones:
    get:
      parameters:
        - description: ID of facility from whom you want to get the zones
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: ''
      operationId: getFacilityZones
      summary: Get the zones of this facility
    post:
      parameters:
        - description: ID of facility from whom you want to create the zone
          in: path
          name: facilityId
          required: true
          schema:
            type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Zone'
          description: The zone was successfully created.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Zone not found
      tags:
        - Core - Facilities
      description: Creates a new zone in this facility.
      operationId: postFacilityZone
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoneForCreation'
        description: The zone to be created
        required: true
      summary: Create a zone
  /api/facilities/{facilityId}/zones/{zoneId}:
    get:
      parameters:
        - description: ID of facility from whom you want to get the zones
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: ''
      operationId: getFacilityZone
      summary: Get the zone of this facility
    delete:
      parameters:
        - description: ID of facility from whom you want to delete the zone
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility or storage location not found
      tags:
        - Core - Facilities
      description: ''
      operationId: deleteFacilityZone
      summary: Delete a zone of a facility with the given ID
    put:
      parameters:
        - description: ID of facility from whom you want to put the zone
          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'
          description: Zone was found & you are allowed to update it.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Facility not found
      tags:
        - Core - Facilities
      description: >-
        Replaces the current zone of this Facility with the provided in the
        body.
      operationId: putFacilityZone
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoneForReplacement'
        description: Patch set
        required: true
      summary: Replace the zones of a Facility
  /api/customservices/{customServiceId}:
    patch:
      parameters:
        - description: ID of custom service you want to patch
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: custom service not found
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: custom service version conflict
      tags:
        - Core - Custom Services
      operationId: patchCustomService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomServicePatchActions'
        description: Patch set
        required: true
      summary: Patches a custom service with the given ID
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
    get:
      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 config could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Custom Services
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getCustomService
      summary: Get requested Custom service
  /api/customservices/{customServiceId}/additionalinformation:
    post:
      parameters:
        - description: ID of custom service you want to create service job for
          in: path
          name: customServiceId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Custom Services
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createCustomServiceAdditionalInformation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdditionalInformationForCreation'
        description: Desired custom service to create
        required: true
      summary: Create a custom service additional information
  /api/customservices/{customServiceId}/additionalinformation/{additionalInformationId}:
    delete:
      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.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Custom Services
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: deleteAdditionalInfo
      summary: Delete a custom service
    put:
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Custom Services
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: updateCustomServiceAdditionalInformation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdditionalInformationForCreation'
        description: Desired custom service to create
        required: true
      summary: Update a custom service additional information
  /api/customservices:
    get:
      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: tenantCustomServiceId to filter for
          in: query
          name: tenantCustomServiceId
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedCustomServices'
          description: Custom service config could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Custom Services
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getCustomServices
      summary: Get Custom services
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully updated.
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomService'
          description: The custom service was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Custom Services
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createCustomService
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomServiceForCreation'
        description: Desired custom service to create
        required: true
      summary: Create a custom service
  /api/facilities/{facilityId}/customservices:
    get:
      parameters:
        - description: ID of facility
          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:
                $ref: '#/components/schemas/StrippedFacilityCustomServiceConnections'
          description: Custom service connections could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Facilities
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getFacilityCustomServiceConnections
      summary: Get requested Custom service connection for a facility
  /api/facilities/{facilityId}/customservices/{customServiceId}:
    get:
      parameters:
        - description: ID of facility
          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: Custom service connection could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Core - Facilities
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getFacilityCustomService
      summary: Get requested Custom service connection for a facility
    patch:
      parameters:
        - description: ID of facility
          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: The custom service connection was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Facilities
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: updateFacilityCustomServiceConnction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCustomServiceConnectionForUpdate'
        description: Desired custom service connection to create/update
        required: true
      summary: Update a facility custom service connection
    post:
      parameters:
        - description: ID of facility
          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:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FacilityCustomServiceConnection'
          description: The custom service connection was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Facilities
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createFacilityCustomServiceConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityCustomServiceConnectionForCreation'
        description: Desired custom service connection to create/update
        required: true
      summary: Create a facility custom service connection
    delete:
      parameters:
        - description: ID of facility
          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 custom service connection was successfully deleted.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Core - Facilities
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: deleteFacilityCustomServiceConnection
      summary: Delete a facility custom service connection
  /api/servicejobs:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJobs'
          description: Service Jobs could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Custom Services
      operationId: getServiceJobs
      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 of the facility you want to filter for
          in: query
          name: facilityRef
          required: false
          schema:
            type: string
        - description: >-
            Reference to the statuses you want to get the corresponding service
            job
          in: query
          name: status
          required: false
          schema:
            type: array
            items:
              type: string
        - description: Type of channel you want to filter for
          in: query
          name: channel
          required: false
          schema:
            $ref: '#/components/schemas/ServiceJobFilterChannel'
        - description: Start target date range for service jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: End target date range for service jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - 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:
            type: string
      summary: Get Service Jobs
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJob'
          description: The service job was successfully created.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Custom Services
      operationId: createServiceJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobForCreation'
        description: Desired service job to create
        required: true
      summary: Create a service job
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/servicejobs/{serviceJobId}:
    get:
      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 could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Custom Services
      operationId: getServiceJob
      summary: Get requested service job
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/servicejobs/{serviceJobId}/actions:
    post:
      parameters:
        - description: ID of service job you want to update
          in: path
          name: serviceJobId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceJob'
          description: The service job was successfully updated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Custom Services
      operationId: updateServiceJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobActionsParameter'
        description: Desired change to a service job
        required: true
      summary: Update a service job
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/linkedservicejobs:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobsPaginatedResult'
          description: LinkedServiceJobs could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Custom Services
      operationId: getLinkedServiceJobs
      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: facilities to filter to
          in: query
          name: facilityIds
          required: false
          schema:
            type: array
            items:
              type: string
        - description: >-
            Reference to the statuses you want to get the corresponding linked
            service jobs
          in: query
          name: status
          required: false
          schema:
            type: array
            items:
              type: string
        - description: sort order
          in: query
          name: orderBy
          required: false
          schema:
            $ref: '#/components/schemas/LinkedServiceJobsOrderBy'
        - description: type of channel you want to filter for
          in: query
          name: channel
          required: false
          schema:
            $ref: '#/components/schemas/LinkedServiceJobsFilterChannel'
        - description: Start target date range for linked service jobs
          in: query
          name: startTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - description: End target date range for linked service jobs
          in: query
          name: endTargetTime
          required: false
          schema:
            type: string
            example: '2020-02-03T08:45:50.525Z'
            format: date-time
        - 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:
            type: string
      summary: Get LinkedServiceJobs
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/linkedservicejobs/{linkedServiceJobsId}:
    get:
      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 could be found in response body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Custom Services
      operationId: getLinkedServiceJobsById
      summary: Get requested LinkedServiceJobs
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks:
    post:
      parameters:
        - description: ID of LinkedServiceJobs you want to alter
          in: path
          name: linkedServiceJobsId
          required: true
          schema:
            type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkedServiceJobs'
          description: The ServiceJobLink was successfully added to the LinkedServiceJobs.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Custom Services
      operationId: addServiceJobLink
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobLinkForAdding'
        description: Desired ServiceJobLink to add
        required: true
      summary: Add a ServiceJobLink to an LinkedServiceJobs on root level
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId}:
    post:
      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
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Custom Services
      operationId: addNestedServiceJobLink
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceJobLinkForAdding'
        description: Desired ServiceJobLink to add
        required: true
      summary: Add a ServiceJobLink to an ServiceJobLInk inside the LinkedServiceJobs
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/operativeprocesses:
    get:
      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
            type: integer
            maximum: 500
            minimum: 1
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/OperativeProcess'
          description: All operative processes matching the given parameters
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Operative Process
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getOperativeProcesses
      summary: Get all operativeProcesses
  /api/operativeprocesses/{operativeProcessId}:
    get:
      parameters:
        - description: id of the operativeProcess you want to retrieve
          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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Operative Process
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getOperativeProcessById
      summary: Get operativeProcess by ID
  /api/operativecontainertypes/{operativeContainerTypeId}:
    get:
      parameters:
        - description: id of the operativeContainer you want to retrieve
          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
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Found operativeContainerType by given ID
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Operative Container
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getOperativeContainerTypeById
      summary: Get operativeContainerType by ID
    patch:
      parameters:
        - description: id of the operativeContainer you want to update
          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: Found operativeContainerType by given ID
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Operative Container
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: updateOperativeContainerTypeById
      summary: Update operativeContainerType by ID
  /api/operativecontainertypes:
    get:
      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
            type: integer
            maximum: 500
            minimum: 1
        - description: OperativeType you want to filter by
          in: query
          name: operativeType
          required: false
          schema:
            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
            operativContainerType. 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/OperativeContainerTypesResponse'
          description: Found operativeProcess by given ID
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Operative Container
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getOperativeContainerTypes
      summary: Get operativeContainerTypes
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperativeContainerType'
          description: Successfully created resource.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - Fulfillment Operations - Operative Container
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: createOperativeContainerType
      summary: Create operativeContainerType
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperativeContainerTypeForCreation'
        required: true
  /api/operativecontainertypes/{operativeContainerTypeId}/icon:
    put:
      parameters:
        - in: path
          name: operativeContainerTypeId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - Fulfillment Operations - Operative Container
      operationId: uploadOperativeContainerTypeIcon
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NamedFile'
        description: Base64 encoded icon to upload
        required: true
      summary: Upload icon for operative container types
  /api/cancelationreasons:
    get:
      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: >-
            Cancelation reasons were found & you were allowed to access them.
            The result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cancelation reason not found
      tags:
        - DOMS - Orders
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getCancelationReasons
      summary: Get a list with all cancelation reasons
    post:
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelationReason'
          description: >-
            The cancelation reason has been successfully created. The Location
            header includes the URL of the document.
        '303':
          description: >-
            The Cancelation Reason already exists. The Location header contains
            the URL of the document.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      operationId: postCancelationReason
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelationReasonForCreation'
        description: Cancelation reason
        required: true
      summary: Post a new cancelation reason
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/cancelationreasons/{cancelationReasonId}:
    get:
      parameters:
        - description: Id of the cancelation 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: >-
            Cancelation reason was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cancelation reason not found
      tags:
        - DOMS - Orders
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getCancelationReasonById
      summary: Get a cancelation reason with the given id
    put:
      parameters:
        - description: ID of the cancelation 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: >-
            Cancelation reason was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cancelation reason not found
      tags:
        - DOMS - Orders
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: putCancelationReason
      summary: Update a cancelation reason
    delete:
      parameters:
        - description: ID of the cancelation reason you intend to delete
          in: path
          name: cancelationReasonId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            The cancelation reason was found, and you have been granted
            permission to delete it.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Cancelation reason not found
      tags:
        - DOMS - Orders
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: deleteCancelationReason
      summary: Delete a cancelation reason
  /api/configurations/routing/toolkit/fences:
    get:
      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/ToolkitFencesTransporter'
          description: The current list of available toolkit fences
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: No more elements available
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getToolkitFences
      summary: Returns all toolkit fences
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolkitFenceForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ToolkitFence'
          description: Toolkit Fence was created successfully.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: postToolkitFence
      summary: Creates a toolkit fence
  /api/configurations/routing/toolkit/fences/{toolkitFenceId}:
    get:
      parameters:
        - description: Id of the toolkit fence you want to get
          in: path
          name: toolkitFenceId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolkitFence'
          description: >-
            ToolkitFence was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getToolkitFenceById
      summary: Get a tag with the given key
    put:
      parameters:
        - description: ID of the toolkit fence you want to update
          in: path
          name: toolkitFenceId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolkitFenceForModification'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolkitFence'
          description: >-
            Toolkit fence was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Toolkit fence not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putToolkitFence
      summary: Update a toolkit fence
    delete:
      parameters:
        - description: ID of the toolkit fence you want to delete
          in: path
          name: toolkitFenceId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Toolkit fence was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Toolkit fence not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: deleteToolkitFence
      summary: Delete a toolkit fence
  /api/configurations/routing/toolkit/ratings:
    get:
      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/ToolkitRatingTransporter'
          description: The current list of available toolkit fences
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: No more elements available
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getToolkitRatings
      summary: Returns all toolkit ratings
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolkitRatingForCreation'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ToolkitRating'
          description: Toolkit Rating was created successfully.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: postToolkitRating
      summary: Creates a toolkit rating
  /api/fulfillability:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fulfillability'
          description: The result of the fulfillability .
        '204':
          description: >-
            There was no result of the fulfillability request. Please make sure
            to provide at least one of the attributes shipping or collect.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated: use /api/promises instead
      operationId: queryFulfillability
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FulfillabilityQuery'
        description: Representation that describes the fulfillability query
        required: true
      summary: >-
        Provides information which kind of fulfillment is possible under given
        circumstances.
  /api/fulfillability/clickandcollect:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillabilityResult'
          description: The result of the fulfillability for click and collect.
        '204':
          description: >-
            There was no result of the fulfillability request. Please make sure
            to provide at least one of the attributes shipping or collect.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated: use /api/promises instead
      operationId: queryFulfillabilityClickAndCollect
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FulfillabilityClickAndCollectQuery'
        description: Representation that describes the fulfillability query
        required: true
      summary: >-
        Provides information which kind of fulfillment is possible under given
        circumstances.
  /api/fulfillability/shipfromstore:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillabilityResult'
          description: The result of the fulfillability for ship from store.
        '204':
          description: There was no result of the fulfillability request.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated: use /api/promises instead
      operationId: queryFulfillabilityShipFromStore
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FulfillabilityShipFromStoreQuery'
        description: Representation that describes the fulfillability query
        required: true
      summary: >-
        Provides information which kind of fulfillment is possible under given
        circumstances.
  /api/promises/checkoutoptions/delivery/earliest:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestResponse'
          description: |-

            The request could be evaluated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: |-

            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />The list of items depicts the items you would like to get information about their earliest possbile delivery. The provided list of tenant article ids are considered individual (as if not in a basket together, but seperately ordered). Additionally you can add information about the address these items should be delivered to to further refine the response. 
      operationId: checkoutoptionDeliveryEarliest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestRequest'
        required: true
      summary: delivery/earliest
  /api/promises/checkoutoptions/delivery/timeperiod:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponse'
          description: |-

            The request could be evaluated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      operationId: checkoutoptionDeliveryTimePeriod
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodRequest'
        required: true
      summary: delivery/timeperiod
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />The basket attribute depicts the items you would like to get details about their possbile delivery. All the provided tenantArticleIds within the basket are considered together (as if they are in the same basket/order). Additionally you can add information about the address these items should be delivered to to further refine the quality of the response.
  /api/promises/checkoutoptions:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ResponseForCNCCheckoutOptions'
                  - $ref: '#/components/schemas/ResponseForSFSCheckoutOptions'
          description: ''
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: postCheckoutOptions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsInput'
        description: The CheckoutOptionsInput
        required: true
      summary: Evaluate a checkout options input against the DOMS
  /api/promises/checkoutoptions/delivery/timepoint:
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointResponse'
          description: |-

            The request could be evaluated.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Checkout Options
      operationId: checkoutOptionsTimepoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointRequest'
        required: true
      summary: >-
        This endpoint is to be used to get information about the possible
        delivery of items
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
  /api/orders:
    get:
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StrippedOrders'
          description: Orders are found.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      description: ''
      operationId: getAllOrders
      summary: Return all orders
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      description: ''
      operationId: addOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderForCreation'
        description: Order object supplied by your shop instance
        required: true
      summary: Add a new order for future fulfillment
  /api/orders/{orderId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - DOMS - Orders
      description: ''
      operationId: getOrder
      summary: Get a order with the given ID
  /api/orders/{orderId}/actions:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderActionsParameter'
      parameters:
        - description: Reference to the order you want to call the action for
          in: path
          name: orderId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: Updated Order in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      operationId: orderAction
      summary: Call a single action on a given order
  /api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderLineItemActionsParameter'
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: Updated Order in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      operationId: orderLineItemAction
      summary: Call a single action on a given order and line item
  /api/routing/commands/reroute:
    post:
      responses:
        '200':
          description: Rerouting was successfully triggered
        '401':
          content:
            '*/*':
              schema:
                items:
                  $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
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><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
      summary: Triggers rerouting of failed routing plans
  /api/routingplans:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found, please look at details.
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: getRoutingPlanBaseOnOrderRef
      summary: Get a routing plan regarding to orderRef
  /api/routingplans/{routingplanId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Not found, please look at details.
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: getRoutingPlan
      summary: Get a routing plan with the given ID
    patch:
      parameters:
        - description: ID of routing plan you want to patch
          in: path
          name: routingplanId
          required: true
          schema:
            type: string
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found, for more information please look at details.
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: patchRoutingPlan
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingPlanPatchActions'
        description: Patch set
        required: true
      summary: Patches a routing plan with the given ID
  /api/routingplans/{routingplanId}/decisionlogs/{routingRun}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Decision log not found
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: getDecisionlog
      summary: Get decision log of a routing plan with the given ID
  /api/reroutedescriptions:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getRerouteDescriptions
      summary: Get a list with all reroute descriptions
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Routing Plans
      operationId: postRerouteDescription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerouteDescriptionForCreation'
        description: The RerouteDescription
        required: true
      summary: Post a new RerouteDescription
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
  /api/reroutedescriptions/{rerouteDescriptionId}:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getRerouteDescriptionById
      summary: Get a reroute description with the given key
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: RerouteDescription not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putRerouteDescription
      summary: Update a reroute description
    delete:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: RerouteDescription not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: deleteRerouteDescription
      summary: Delete a reroute description
  /api/configurations/capacityplanningtimeframe:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: getCapacityPlanningTimeframeConfiguration
      summary: Get a tenant capacity planning timeframe configuration
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
          description: Configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Configuration not found
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: putCapacityPlanningTimeframeConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
        required: true
      summary: Update capacity planning timeframe configuration of a tenant
  /api/orders/{orderId}/cancel:
    post:
      parameters:
        - description: ID of order you want to cancel
          in: path
          name: orderId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: Order was cancelled sucessfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found
      tags:
        - DOMS - Orders
      operationId: cancelOrder
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                cancelationReasonId:
                  description: ID of the cancelation reason
                  type: string
      summary: Cancel an order with the given ID
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated: Use /actions with "CANCEL" instead.
  /api/promises/deliverypromise:
    post:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: postDeliveryPromise
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderForCreation'
        description: Order object supplied by your shop instance
        required: true
      summary: Add a new order for future fulfillment
  /api/configurations/routing/toolkit/ratings/{toolkitRatingId}:
    get:
      parameters:
        - description: Id of the tag you want to get
          in: path
          name: toolkitRatingId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolkitRating'
          description: >-
            ToolkitRating was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: User not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getToolkitRatingById
      summary: Get a tag with the given key
    put:
      parameters:
        - description: ID of the toolkit rating you want to update
          in: path
          name: toolkitRatingId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ToolkitRatingForModification'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolkitRating'
          description: >-
            Toolkit rating was found & you were allowed to access it. The result
            is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Toolkit rating not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putToolkitRating
      summary: Update a toolkit rating
    delete:
      parameters:
        - description: ID of the toolkit rating you want to delete
          in: path
          name: toolkitRatingId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Toolkit rating was found & you were allowed to delete it.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Toolkit rating not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: deleteToolkitRating
      summary: Delete a toolkit rating
  /api/configurations/routing/rerouteshortpick:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteShortPickConfiguration'
          description: >-
            Reroute short pick configuration was found & you were allowed to
            access it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Reroute configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getRerouteShortPickConfiguration
      summary: Get a tenant reroute short pick config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteShortPickConfiguration'
          description: Reroute short pick configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Reroute short pick configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putRerouteShortPickConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerouteShortPickConfiguration'
        required: true
      summary: Update reroute short pick configuration of a tenant
  /api/configurations/routing/reroutetimetriggered:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteTimeTriggeredConfiguration'
          description: >-
            Reroute time triggered configuration was found & you were allowed to
            access it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Reroute configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getRerouteTimeTriggeredConfiguration
      summary: Get a tenant reroute time triggered config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RerouteTimeTriggeredConfiguration'
          description: Reroute time triggered configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Reroute configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: putRerouteTimeTriggeredConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RerouteTimeTriggeredConfiguration'
        required: true
      summary: Update reroute time triggered configuration of a tenant
  /api/configurations/routing/manualreroute:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManualRerouteConfiguration'
          description: >-
            Manual reroute configuration was found & you were allowed to access
            it. The result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Manual reroute configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated, use GlobalManualRerouteConfiguration in
        /api/configurations/routing
      deprecated: true
      operationId: getManualRerouteConfiguration
      summary: Get a tenant manual order reroute config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManualRerouteConfiguration'
          description: Manual order reroute configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Reroute configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Deprecated, use GlobalManualRerouteConfiguration in
        /api/configurations/routing
      deprecated: true
      operationId: putManualRerouteConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManualRerouteConfiguration'
        required: true
      summary: Update manual order reroute configuration of a tenant
  /api/configurations/promises:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Promises configuration not found
      tags:
        - DOMS - Orders
      description: ''
      operationId: getPromisesConfiguration
      summary: Get a tenant promises config
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromisesConfiguration'
          description: The promisesConfiguration was successfully put.
        '400':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Orders
      description: ''
      operationId: putPromisesConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromisesConfiguration'
        description: Desired promises configuration to put
        required: true
      summary: Change the tenant wide promises configuration
  /api/configurations/routing:
    get:
      parameters:
        - description: Provide  to get an older version of the configuration
          in: query
          name: version
          schema:
            type: number
        - description: >-
            Provide the localized names and descriptions for the routing
            configuration. 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/RoutingConfiguration'
          description: >-
            Routing configuration was found & you were allowed to access it. The
            result is in the body.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Routing configuration not found
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: getRoutingConfiguration
      summary: Get a tenant routing config
    patch:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingConfiguration'
          description: Routing configuration was found & patch-set has been applied.
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity not found, for more information please look at details.
        '409':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Entity version conflict
      tags:
        - DOMS - Routing Plans
      description: >-
        Important: You can only change the name and the description for fences,
        ratings and prioritizations of type CUSTOM. For Fences and Ratings
        provided by fulfillmenttools you can not change the fields 'name' and
        'description'.
      operationId: patchRoutingConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingConfigurationsPatchActions'
        description: Patch set
        required: true
      summary: Patches routing configuration
    put:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutingConfiguration'
          description: Routing configuration was written successfully
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
        '404':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Routing configuration not found
      tags:
        - DOMS - Routing Plans
      description: >-
        Important: You can only change the name and the description for fences,
        ratings and prioritizations of type CUSTOM. For Fences and Ratings
        provided by fulfillmenttools you can not change the fields 'name' and
        'description'. <br> Also you can not delete an existing fulfillmenttools
        Fence or Rating by calling this endpoint.
      operationId: putRoutingConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoutingConfiguration'
        required: true
      summary: Update routing configuration of a tenant
  /api/configurations/orderrouting:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getOrderRoutingConfiguration
      summary: Get the tenant wide order routing configuration
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: putOrderRoutingConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRoutingConfiguration'
        description: Desired order routing configuration to create/update
        required: true
      summary: Change the tenant wide order routing configuration
  /api/configurations/ordercancelation:
    get:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Routing Plans
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      operationId: getOrderCancelationConfiguration
      summary: Get the tenant wide order cancelation configuration
    put:
      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:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Invalid input. See response for details
        '401':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: Your user is not allowed to operate against this API instance
        '403':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiError'
          description: >-
            Your user, although recognized, is not authorized to use this
            endpoint
      tags:
        - DOMS - Routing Plans
      description: ''
      operationId: putOrderCancelationConfiguration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderCancelationConfiguration'
        description: Desired order cancelation configuration to create/update
        required: true
      summary: Change the tenant wide order cancelation configuration
  /api/articles:
    get:
      operationId: getArticles
      summary: Search articles tenant-wide based on title or tenantArticleId
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: facilityRef
          required: false
          in: query
          schema:
            type: string
        - name: searchTerm
          required: false
          in: query
          schema:
            minLength: 1
            type: string
        - name: locale
          required: false
          in: query
          schema:
            type: string
            $ref: '#/components/schemas/SupportedLocale'
        - name: tenantArticleId
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: >-
            Articles search result according to the request. The result is in
            the body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryArticlePaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/articles/{tenantArticleId}/forecasts:
    get:
      operationId: getForecastsForArticle
      summary: Get the forecast for a specific tenantArticleId
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: tenantArticleId
          required: true
          in: path
          schema:
            type: string
        - name: period
          required: false
          in: query
          schema:
            enum:
              - DAILY
            type: string
      responses:
        '200':
          description: >-
            Forecast for the specified tenantArticleId. The result is in the
            body.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArticleStockForecast'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/purchaseorders/{purchaseOrderId}:
    get:
      operationId: getPurchaseOrder
      summary: Get a Purchase Order by ID
      deprecated: false
      description: ''
      parameters:
        - name: purchaseOrderId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Purchase Order entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    put:
      operationId: upsertPurchaseOrder
      summary: Update or create a Purchase Order
      deprecated: false
      description: ''
      parameters:
        - name: purchaseOrderId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOrderForUpdate'
      responses:
        '200':
          description: Updated/created Purchase Order entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    patch:
      operationId: patchPurchaseOrder
      summary: Partially updates a Purchase Order using a selection of fields
      deprecated: false
      description: ''
      parameters:
        - name: purchaseOrderId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOrderForPartialUpdate'
      responses:
        '200':
          description: Updated Purchase Order entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/purchaseorders:
    post:
      operationId: createPurchaseOrder
      summary: Create a new Purchase Order
      deprecated: false
      description: ''
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOrderForCreation'
      responses:
        '201':
          description: Created Purchase Order entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundprocesses:
    get:
      operationId: getInboundProcesses
      summary: Get multiple Inbound Processes
      deprecated: false
      description: ''
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: sort
          required: false
          in: query
          schema:
            enum:
              - ORIGIN_NAME_ASC
              - REQUESTED_DATE_ASC
              - LAST_MODIFIED_ASC
              - ORIGIN_NAME_DESC
              - REQUESTED_DATE_DESC
              - LAST_MODIFIED_DESC
            type: string
        - name: facilityRef
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
        - name: scannableCode
          required: false
          in: query
          schema:
            type: string
        - name: status
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - OPEN
                - PARTIAL_DELIVERY
                - ON_HOLD
                - CLOSED
        - name: searchTerm
          required: false
          in: query
          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
          schema:
            type: string
        - name: searchTermExact
          required: false
          in: query
          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
          schema:
            type: string
        - name: purchaseOrder_cancelled
          required: false
          in: query
          schema:
            type: boolean
        - name: receipt_status
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - IN_PROGRESS
                - FINISHED
      responses:
        '200':
          description: Paginated result containing the matching Inbound Process entities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    post:
      operationId: createInboundProcess
      summary: Create a new Inbound Process
      deprecated: false
      description: ''
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessForCreation'
      responses:
        '200':
          description: Created Inbound Process entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcess'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundprocesses/{inboundProcessId}:
    get:
      operationId: getInboundProcess
      summary: Get an Inbound Process by ID
      deprecated: false
      description: ''
      parameters:
        - name: inboundProcessId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Requested Inbound Process entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcess'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    delete:
      operationId: deleteInboundProcess
      summary: Delete an Inbound Process by ID
      deprecated: false
      description: ''
      parameters:
        - name: inboundProcessId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Inbound Process successfully deleted
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    patch:
      operationId: Patch InboundProcess
      summary: Patch an Inbound Process by ID
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: inboundProcessId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessForPatch'
      responses:
        '200':
          description: Inbound Process successfully patched
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundprocesses/{inboundProcessId}/purchaseorder:
    put:
      operationId: upsertInboundProcessPurchaseOrder
      summary: >-
        Creates or updates the specific purchase order of an existing inbound
        process.
      deprecated: false
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      parameters:
        - name: inboundProcessId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundProcessPurchaseOrderForUpsert'
      responses:
        '200':
          description: Purchase order successfully updated on inbound process
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        '201':
          description: Purchase order successfully created on inbound process
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundProcessPurchaseOrder'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundprocesses/{inboundProcessId}/receipts:
    post:
      operationId: addReceiptToInboundProcess
      summary: Adds a receipt to an inbound process.
      deprecated: false
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      parameters:
        - name: inboundProcessId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundReceiptForCreation'
      responses:
        '201':
          description: Receipt was added to the inbound process
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundReceipt'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundreceiptjobs:
    get:
      operationId: getInboundReceiptJobs
      summary: Get InboundReceiptJobs
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: facilityRef
          required: false
          in: query
          schema:
            type: array
            items:
              type: string
        - name: status
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - OPEN
                - PARTIAL_DELIVERY
                - ON_HOLD
                - CLOSED
        - name: searchTerm
          required: false
          in: query
          schema:
            minLength: 1
            type: string
        - name: searchTermExact
          required: false
          in: query
          schema:
            minLength: 1
            type: string
        - name: fromDate
          required: false
          in: query
          schema:
            format: date-time
            type: string
        - name: toDate
          required: false
          in: query
          schema:
            format: date-time
            type: string
      responses:
        '200':
          description: Paginated Inbound Receipt Jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundReceiptJobPaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundreceiptjobs/{inboundEntryId}:
    get:
      operationId: getInboundReceiptJob
      summary: Get an Inbound Receipt Job by ID
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: inboundEntryId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundReceiptJob'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/receipts:
    post:
      operationId: createReceipt
      summary: Creates a receipt
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReceiptForCreation'
      responses:
        '201':
          description: Created inbound receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/receipts/{receiptId}:
    get:
      operationId: getReceipt
      summary: Get receipt by id
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: receiptId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    put:
      operationId: putReceipt
      summary: Put receipt to id
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: receiptId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundReceiptForUpdate'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    patch:
      operationId: patchReceipt
      summary: Patch receipt by id
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: receiptId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundReceiptForPatch'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
    delete:
      operationId: deleteReceipt
      summary: Delete receipt by id
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: receiptId
          required: true
          in: path
          schema:
            type: string
        - name: version
          required: true
          in: query
          schema:
            type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/configurations/inventory:
    patch:
      operationId: upsertInventoryConfigurations
      summary: Update Inventory Configuration
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryConfigurationForPatch'
      responses:
        '200':
          description: Requested Inventory Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryConfiguration'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    get:
      operationId: getInventoryConfigurations
      summary: Get Inventory Configuration
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      responses:
        '200':
          description: Requested Inventory Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryConfiguration'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/facilities/{facilityId}/configurations/inventory:
    patch:
      operationId: upsertInventoryFacilityConfigurations
      summary: Update Inventory Configuration for a Facility
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: facilityId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryFacilityConfigurationForPatch'
      responses:
        '200':
          description: Requested Inventory Facility Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryFacilityConfiguration'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    get:
      operationId: getInventoryFacilityConfigurations
      summary: Get Inventory Configuration for a Facility
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: facilityId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Requested Inventory Facility Configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryFacilityConfiguration'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/stocks/{stockId}/locationrecommendations:
    get:
      operationId: getStorageLocationRecommendations
      summary: Get the Storage Location recommendations for a specific Stock
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: stockId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: >-
            List of Storage Locations sorted by the stock sum ascending. The
            result is in the body.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StorageLocationRecommendation'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/inboundprocesses/attachments:
    post:
      operationId: createAttachment
      summary: Creates an attachment
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InboundAttachmentForCreation'
      responses:
        '201':
          description: Created attachment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboundAttachment'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/inboundprocesses/attachments/{attachmentId}/signedurl:
    get:
      operationId: getSignedAttachmentUrl
      summary: Retrieves a signed url for an attachment
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: attachmentId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Signed url
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Inbound
  /api/stocks/summaries:
    get:
      operationId: getStockSummaries
      summary: Get the accumulated Stock for each Article
      deprecated: false
      description: ''
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: facilityServiceTypes
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - SHIP_FROM_STORE
                - PICKUP
        - name: facilityStatus
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - ONLINE
                - SUSPENDED
                - OFFLINE
        - name: facilityRefs
          required: false
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: allowStale
          required: false
          in: query
          schema:
            type: boolean
        - name: tenantArticleIds
          required: false
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: channelRefs
          required: false
          in: query
          explode: true
          description: >-
            The channels to included under "channelAdjusted" in the stock
            summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
            unallocated stock."
          schema:
            maxItems: 50
            type: array
            items:
              type: string
      responses:
        '200':
          description: >-
            Stock summaries was loaded & you were allowed to access it. The
            result is in the body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockSummaries'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/inventory/stocks/summaries:
    get:
      operationId: getStockSummariesDeprecated
      summary: This endpoint is deprecated. Please use /api/stocks/summaries instead.
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: facilityServiceTypes
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - SHIP_FROM_STORE
                - PICKUP
        - name: facilityStatus
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - ONLINE
                - SUSPENDED
                - OFFLINE
        - name: facilityRefs
          required: false
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: allowStale
          required: false
          in: query
          schema:
            type: boolean
        - name: tenantArticleIds
          required: false
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: channelRefs
          required: false
          in: query
          explode: true
          description: >-
            The channels to included under "channelAdjusted" in the stock
            summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
            unallocated stock."
          schema:
            maxItems: 50
            type: array
            items:
              type: string
      responses:
        '200':
          description: >-
            Stock summaries was loaded & you were allowed to access it. The
            result is in the body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockSummaries'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/articles/{tenantArticleId}/stockdistribution:
    get:
      operationId: getStockDistribution
      summary: >-
        Stock per Facility for a specific tenantArticleId, also includes the
        Tenant-Wide Summary
      deprecated: false
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      parameters:
        - name: tenantArticleId
          required: true
          in: path
          schema:
            minLength: 1
            type: string
        - name: facilityServiceTypes
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - SHIP_FROM_STORE
                - PICKUP
        - name: facilityStatus
          required: false
          in: query
          explode: false
          schema:
            type: array
            items:
              type: string
              enum:
                - ONLINE
                - SUSPENDED
                - OFFLINE
        - name: facilityName
          required: false
          in: query
          schema:
            minLength: 1
            type: string
        - name: facilityIds
          required: false
          in: query
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: channelRefs
          required: false
          in: query
          explode: true
          description: >-
            The channels to included under "channelAdjusted" in each summary and
            facility stock. Provide up to 50 channelRefs, specify "UNALLOCATED
            for unallocated stock."
          schema:
            maxItems: 50
            type: array
            items:
              type: string
      responses:
        '200':
          description: >-
            Stock distribution was loaded & you were allowed to access it. The
            result is in the body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockDistribution'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/facilities/{facilityId}/stocks:
    get:
      operationId: getFacilityStocks
      summary: Get stock related to a facilityRef
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Use <a
        href="https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/entities#stock">Inventory
        Stock</a> instead
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: facilityId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Stock was loaded and you were allowed to access it.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FacilityStock'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    put:
      operationId: bulkUpdateFacilityStock
      summary: Update Stock in bulk facilityRef and tenantArticleId
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />Use <a
        href="https://docs.fulfillmenttools.com/api-docs/use-cases/inventory-management/entities#stock">Inventory
        Stock</a> instead
      parameters:
        - name: facilityId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FacilityStockBulkOperations'
      responses:
        '207':
          description: Update Result of each targeted tenantArticleId
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FacilityStockBulkResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/stocks:
    post:
      operationId: createStock
      summary: Create stock
      deprecated: false
      description: ''
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockForCreation'
      responses:
        '201':
          description: Stock was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stock'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    get:
      operationId: getStocks
      summary: Get stocks
      deprecated: false
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      parameters:
        - name: facilityRef
          required: false
          in: query
          schema:
            type: string
        - name: tenantArticleId
          required: false
          in: query
          schema:
            maxItems: 500
            type: array
            items:
              type: string
        - name: locationRef
          required: false
          in: query
          schema:
            maxItems: 500
            type: array
            items:
              type: string
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Stocks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockPaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    put:
      operationId: upsertStocks
      summary: Update and create many stocks at once
      deprecated: false
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StocksForUpsert'
      responses:
        '200':
          description: Stock upsert result
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StockUpsertOperationResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/stocks/{stockId}:
    put:
      operationId: updateStock
      summary: Update stock
      deprecated: false
      description: ''
      parameters:
        - name: stockId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/StockForUpdate'
                - type: object
                  properties:
                    value:
                      type: integer
                      minimum: 0
                      format: int32
                    locationRef:
                      type: string
                      nullable: true
                  required:
                    - value
                  not:
                    required:
                      - version
      responses:
        '200':
          description: Stock
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stock'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    delete:
      operationId: deleteStock
      summary: Delete stock
      deprecated: false
      description: ''
      parameters:
        - name: stockId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Stock was deleted.
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    get:
      operationId: getStock
      summary: Get stock
      deprecated: false
      description: ''
      parameters:
        - name: stockId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Stock
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Stock'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/stocks/actions:
    post:
      operationId: performStocksActions
      summary: Perform stocks actions
      deprecated: false
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
          /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StockAction'
      responses:
        '200':
          description: Stock action result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StockActionResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/safetystocks:
    get:
      operationId: getSafetyStocks
      summary: Get all Safety Stocks
      deprecated: false
      description: ''
      parameters:
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
        - name: tenantArticleId
          required: false
          in: query
          schema:
            type: string
        - name: facilityRef
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Available Safety Stocks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafetyStocksPaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
    put:
      operationId: bulkUpdateSafetyStock
      summary: Update Safety Stocks in bulk
      deprecated: false
      description: ''
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SafetyStockBulkOperations'
      responses:
        '207':
          description: Result of the bulk operations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafetyStockBulkOperationResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/safetystocks/{safetyStockId}:
    delete:
      operationId: deleteSafetyStock
      summary: Delete a single Safety Stock
      deprecated: false
      description: ''
      parameters:
        - name: safetyStockId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: Result of the bulk operations
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Stocks
  /api/configurations/notifications:
    get:
      operationId: getNotificationCenterConfig
      summary: Returns the notification center configuration.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      responses:
        '200':
          description: The notification center configuration was successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
    put:
      operationId: upsertNotificationCenterConfig
      summary: Creates or updates an existing notification center configuration.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
                - type: object
                  allOf:
                    - $ref: '#/components/schemas/NotificationCenterConfigForCreation'
                  not:
                    required:
                      - version
      responses:
        '200':
          description: Notification center configuration was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '201':
          description: Notification center configuration was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '400':
          description: Invalid input. See response for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: A version conflict occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
  /api/configurations/notifications/channels/{channelId}:
    delete:
      operationId: deleteNotificationCenterConfigChannel
      summary: Deletes a notification center config channel.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: channelId
          required: true
          in: path
          schema:
            type: string
        - name: version
          required: true
          in: query
          schema:
            type: number
      responses:
        '200':
          description: Notification center config channel was successfully deleted.
        '400':
          description: Invalid input. See response for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: A version conflict occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
  /api/configurations/notifications/actions:
    post:
      operationId: executeNotificationCenterConfigAction
      summary: Executes an action to manipulate the notification center configuration.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddChannelAction'
                - $ref: '#/components/schemas/UpdateChannelByIdAction'
      responses:
        '200':
          description: Notification center configuration action was successfully executed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '400':
          description: Invalid input. See response for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: A version conflict occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
  /api/facilities/{facilityRef}/configurations/notifications:
    get:
      operationId: getNotificationCenterFacilityConfig
      summary: Returns the notification center facility configuration.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: facilityRef
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: >-
            The notification center facility configuration was successfully
            returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
    put:
      operationId: upsertNotificationCenterFacilityConfig
      summary: >-
        Creates or updates an existing notification center facility
        configuration.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: facilityRef
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
                - type: object
                  allOf:
                    - $ref: '#/components/schemas/NotificationCenterConfigForCreation'
                  not:
                    required:
                      - version
      responses:
        '200':
          description: Notification center facility configuration was successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '201':
          description: Notification center facility configuration was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '400':
          description: Invalid input. See response for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: A version conflict occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
  /api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}:
    delete:
      operationId: deleteNotificationCenterFacilityConfigChannel
      summary: Deletes a notification center facility config channel.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: facilityRef
          required: true
          in: path
          schema:
            type: string
        - name: channelId
          required: true
          in: path
          schema:
            type: string
        - name: version
          required: true
          in: query
          schema:
            type: number
      responses:
        '200':
          description: >-
            Notification center facility config channel was successfully
            deleted.
        '400':
          description: Invalid input. See response for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: A version conflict occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
  /api/facilities/{facilityRef}/configurations/notifications/actions:
    post:
      operationId: executeNotificationCenterFacilityConfigAction
      summary: >-
        Executes an action to manipulate the notification center facility
        configuration.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: facilityRef
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddChannelAction'
                - $ref: '#/components/schemas/UpdateChannelByIdAction'
      responses:
        '200':
          description: >-
            Notification center facility configuration action was successfully
            executed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationCenterConfig'
        '400':
          description: Invalid input. See response for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '409':
          description: A version conflict occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Core - Notification Center
  /api/availabilitychannels:
    post:
      operationId: createAvailabilityChannel
      summary: Create a new Availability Channel
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityChannelForCreation'
      responses:
        '200':
          description: The created Availability Channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityChannel'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    get:
      operationId: getAvailabilityChannels
      summary: Get all Availability Channels
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: searchTerm
          required: false
          in: query
          schema:
            type: string
        - name: searchTermExact
          required: false
          in: query
          schema:
            type: string
        - name: strategy
          required: false
          in: query
          schema:
            enum:
              - REGULAR
              - IRON_RESERVE
              - RESTRICT
            type: string
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Available Availability Channels
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityChannelPaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
  /api/availabilitychannels/{availabilityChannelId}:
    put:
      operationId: replaceAvailabilityChannel
      summary: Replace an existing Availability Channel
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityChannelForReplacement'
      responses:
        '200':
          description: The replaced Availability Channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityChannel'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    get:
      operationId: getAvailabilityChannelById
      summary: Get an Availability Channel by its id
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The Availability Channel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityChannel'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    delete:
      operationId: deleteAvailabilityChannel
      summary: >-
        Delete an existing Availability Channel. PLEASE NOTE: This will also
        delete all groups and allocations under this channel.
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The channel has been deleted
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
  /api/availabilitychannels/{availabilityChannelId}/groups:
    get:
      operationId: getGroupsUnderChannel
      summary: Get Groups under Channel
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
        - name: searchTerm
          required: false
          in: query
          schema:
            type: string
        - name: searchTermExact
          required: false
          in: query
          schema:
            type: string
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Available Groups
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AvailabilityAllocationGroupPaginatedResult
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    post:
      operationId: createGroupUnderChannel
      summary: Create a Group under Channel
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/AvailabilityAllocationGroupForCreationUnderChannel
      responses:
        '200':
          description: The created Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityAllocationGroup'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
  /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}:
    put:
      operationId: replaceGroupUnderChannel
      summary: Replace a  Group under Channel
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
        - name: groupId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityAllocationGroupForReplacement'
      responses:
        '200':
          description: The replaced Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityAllocationGroup'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    get:
      operationId: getGroupUnderChannelById
      summary: Get Groups under Channel by its ID
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
        - name: groupId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The Group
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AvailabilityAllocationGroupPaginatedResult
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    delete:
      operationId: deleteGroupUnderChannel
      summary: Delete an existing Group and all its allocations under Channel
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: groupId
          required: true
          in: path
          schema:
            type: string
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The Group has been deleted.
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
  /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations:
    get:
      operationId: getAllocationsUnderGroup
      summary: Get Allocations under Group
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: groupId
          required: true
          in: path
          schema:
            type: string
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
        - name: searchTerm
          required: false
          in: query
          schema:
            type: string
        - name: searchTermExact
          required: false
          in: query
          schema:
            type: string
        - name: size
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: startAfterId
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Available Allocations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityAllocationPaginatedResult'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    post:
      operationId: createAllocationUnderGroup
      summary: Create a new Allocation under Group
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: groupId
          required: true
          in: path
          schema:
            type: string
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityAllocationForCreationUnderGroup'
      responses:
        '200':
          description: The created Allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityAllocation'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
  /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}:
    put:
      operationId: replaceAllocationUnderGroup
      summary: Replace an existing Allocation under a group
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: groupId
          required: true
          in: path
          schema:
            type: string
        - name: allocationId
          required: true
          in: path
          schema:
            type: string
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityAllocationForReplacement'
      responses:
        '200':
          description: The replaced Allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityAllocation'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    get:
      operationId: getAllocationUnderGroupById
      summary: Get an Allocation under a Group by its id
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: groupId
          required: true
          in: path
          schema:
            type: string
        - name: allocationId
          required: true
          in: path
          schema:
            type: string
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The Allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityAllocation'
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
    delete:
      operationId: deleteAllocationUnderGroup
      summary: Delete an existing Allocation under Group
      deprecated: false
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      parameters:
        - name: allocationId
          required: true
          in: path
          schema:
            type: string
        - name: groupId
          required: true
          in: path
          schema:
            type: string
        - name: availabilityChannelId
          required: true
          in: path
          schema:
            type: string
      responses:
        '200':
          description: The Allocation has been deleted
        '401':
          description: Your user is not allowed to operate against this API instance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Your user, although recognized, is not authorized to use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: The requested entity was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      tags:
        - Inventory Management - Channel Availability
  /graphql:
    get:
      responses:
        '200':
          description: The GraphQL playground
      tags:
        - Infrastructure - GraphQL
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: getGraphQLPlayground
      summary: Get the GraphQL playground
    post:
      responses:
        '200':
          description: The GraphQL command was successfully executed.
        '400':
          description: GraphQL validation error
      tags:
        - Infrastructure - GraphQL
      description: |-
        <i><center>
          <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
          </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
          under our SLA regulations. For details on this topic please check our
          <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
          </i><br /><br />
      operationId: executeGraphQLCommand
      summary: Endpoint for executing GraphQL commands
components:
  requestBodies:
    MeasurementUnitForCreation:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MeasurementUnitForCreation'
      required: true
  schemas:
    AbstractCarrierCredentials:
      discriminator:
        propertyName: key
      properties:
        key:
          type: string
      required:
        - key
      type: object
      xml:
        name: AbstractCarrierCredentials
    AbstractModificationAction:
      discriminator:
        propertyName: action
      properties:
        action:
          description: ''
          enum:
            - AddAllowedValueToTag
            - ModifyPickJob
            - ModifyPickJobLastEditor
            - RestartPickJob
            - ResetPickJob
            - CancelPickRun
            - CancelHandoverjob
            - AbortPickJob
            - FinishPickRun
            - StartPickRun
            - ModifyPickLineItem
            - ModifyPickRunLineItem
            - ModifyPackJob
            - PausePackJob
            - ModifyPackLineItem
            - ModifyFacility
            - ModifyListing
            - ModifyRetainedOfflineStock
            - ModifyListingReactivationAfter
            - ModifyUser
            - ModifyShipment
            - ModifyHandoverjob
            - ModifyCarrier
            - ModifyShortpick
            - ModifyReturn
            - ModifyReturnLineItem
            - ModifyRoutingPlan
            - ModifyFence
            - ModifyRating
            - ModifyTimingMode
            - ModifyGlobalRoutingConfiguration
            - ModifyOrderSplit
            - ModifyPrioritization
            - ModifyLoadUnitType
            - ModifyFeature
            - ModifyParcel
            - ModifyParcelLoadUnit
            - ModifyRestowItem
            - RemovePickJobFromPickRunAction
            - ModifyPartialStock
            - AddTagsToProcess
            - AssignFacilityToProcess
            - ModifyStorageLocation
            - ModifyPackingContainerType
            - ModifyPackingContainerTypeIcon
            - ReplaceCodesInPackingTargetContainer
            - ReplaceLoadUnitLineItems
            - AddLineItemToPackingTargetContainer
            - RemoveLineItemFromPackingTargetContainer
            - UpdateLineItemOnPackingTargetContainer
            - ModifyCustomService
            - UnlockOrder
          example: <Use the corresponding action, see documentation>
          type: string
      required:
        - action
      type: object
      xml:
        name: AbstractModificationAction
    AbstractModifyCarrierCredentials:
      discriminator:
        propertyName: key
      properties:
        key:
          type: string
      required:
        - key
      type: object
      xml:
        name: AbstractModifyCarrierCredentials
    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
        province:
          example: NRW
          pattern: ^.+$
          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
          type: array
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      required:
        - street
        - city
        - postalCode
        - country
      type: object
    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
    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
    Branding:
      properties:
        logoUrl:
          description: The logo URL for the tenant
          example: https://ocff-transloadit.storage.googleapis.com/thumbnails/logo.jpg
          format: uri
          type: string
        primaryColor:
          description: The hexcode representation of the desired primary color.
          example: '#FFC0CB'
          pattern: ^#([A-Fa-f0-9]{6})$
          type: string
      required:
        - primaryColor
        - logoUrl
      type: object
      xml:
        name: Branding
    CallbackHeader:
      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
      type: object
    CapabilityStatus:
      enum:
        - enabled
        - inactive
        - disabled
      type: string
    ParcelLabelClassificationForCreation:
      additionalProperties: false
      properties:
        nameLocalized:
          description: Localized name for parcel label classification
          example:
            de_DE: S-Paket
            en_US: S-Parcel
            ru_RU: S-пакет
          $ref: '#/components/schemas/LocaleString'
        services:
          $ref: '#/components/schemas/ParcelLabelClassificationServices'
        dimensions:
          $ref: '#/components/schemas/ParcelDimensions'
      required:
        - nameLocalized
        - dimensions
      type: object
    ParcelLabelClassification:
      additionalProperties: false
      properties:
        name:
          description: Name of the parcel label classification
          example: S-Parcel
          type: string
        nameLocalized:
          description: Localized name for parcel label classification
          example:
            de_DE: S-Paket
            en_US: S-Parcel
            ru_RU: S-пакет
          $ref: '#/components/schemas/LocaleString'
        services:
          $ref: '#/components/schemas/ParcelLabelClassificationServices'
        dimensions:
          $ref: '#/components/schemas/ParcelDimensions'
      required:
        - nameLocalized
        - dimensions
      type: object
    ParcelLabelClassificationServices:
      additionalProperties: false
      properties:
        bulkyGoods:
          type: boolean
          default: false
      type: object
    Carrier:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/CarrierForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            id:
              description: The id of the carrier
              example: LGMl2DuvPnfPoSHhYFOm
              type: string
            deliveryType:
              $ref: '#/components/schemas/CarrierDeliveryType'
            lifecycle:
              $ref: '#/components/schemas/CarrierLifecycle'
            parcelLabelClassifications:
              items:
                $ref: '#/components/schemas/ParcelLabelClassification'
              type: array
            defaultParcelWidthInCm:
              description: Default width in cm
              default: 35
              minimum: 1
              type: number
            defaultParcelLengthInCm:
              description: Default length in cm
              default: 25
              minimum: 1
              type: number
            defaultParcelHeightInCm:
              description: Default height in cm
              default: 10
              minimum: 1
              type: number
          required:
            - id
            - status
            - defaultParcelWidthInCm
            - defaultParcelLengthInCm
            - defaultParcelHeightInCm
          type: object
      xml:
        name: Carrier
    BringCarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        customerId:
          type: string
          example: '12345'
          description: Bring Carrier customer number.
        supportPhoneNumber:
          type: string
          example: '0031121424242'
          description: Bring Carrier support phone number.
        shipmentProduct:
          type: string
          example: '5600'
          description: Product that will be used for the shipment booking
        returnProduct:
          type: string
          example: '9300'
          description: Product that will be used for return
        trackAndTraceUrl:
          type: string
        webhookFftHost:
          type: string
      required:
        - customerId
        - supportPhoneNumber
    FedexCarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        useEconomyService:
          type: boolean
          example: true
          description: Indicates if the economy services of fedex should be used.
        defaultPriceValue:
          type: number
          example: 10.99
          description: Default value of shipped goods
        defaultPriceCurrency:
          type: string
          example: EUR
          description: default currency of shipped goods as 3 letter iso code
          pattern: ^[A-Z]{3}$
        defaultManufactureCountry:
          description: A two-digit country code as per ISO 3166-1 alpha-2
          example: DE
          pattern: ^[A-Z]{2}$
          type: string
        defaultCommodityDescription:
          type: string
          example: Description goes here
          description: Describes the shipped goods
        trackAndTraceUrl:
          type: string
      required:
        - useEconomyService
        - defaultPriceCurrency
        - defaultPriceValue
        - defaultManufactureCountry
        - defaultCommodityDescription
    DpdChCarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        alternativeSendAddress:
          $ref: '#/components/schemas/FacilityAddress'
        trackAndTraceUrl:
          type: string
    DhlV2CarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        alternativeReturnAddress:
          $ref: '#/components/schemas/FacilityAddress'
        trackAndTraceUrl:
          type: string
    VceCarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        alternativeReturnAddress:
          $ref: '#/components/schemas/FacilityAddress'
    GlsCarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        alternativeSendAddressLocationId:
          type: string
          minLength: 1
        alternativeReturnAddressLocationId:
          type: string
          minLength: 1
        trackAndTraceUrl:
          type: string
        trackAndTraceWsdlUrl:
          type: string
    PostNlCarrierConfiguration:
      allOf:
        - $ref: '#/components/schemas/CarrierConfiguration'
      properties:
        trackAndTraceUrl:
          type: string
    CarrierDeliveryType:
      description: 'Provided delivery of this CEP. Default: DELIVERY'
      enum:
        - SAMEDAY
        - DELIVERY
      type: string
    CarrierForCreation:
      additionalProperties: false
      properties:
        credentials:
          $ref: '#/components/schemas/AbstractCarrierCredentials'
        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:
          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
        status:
          $ref: '#/components/schemas/CarrierStatus'
        defaultParcelWeightInGram:
          description: Default weight for a parcel in gram
          default: 1000
          minimum: 1
          type: number
        defaultParcelWidthInCm:
          description: Default width in cm
          default: 35
          minimum: 1
          type: number
        defaultParcelLengthInCm:
          description: Default length in cm
          default: 25
          minimum: 1
          type: number
        defaultParcelHeightInCm:
          description: Default height in cm
          default: 10
          minimum: 1
          type: number
        parcelLabelClassifications:
          items:
            $ref: '#/components/schemas/ParcelLabelClassificationForCreation'
          type: array
        productValueNeeded:
          type: boolean
          example: true
          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)
      required:
        - name
        - key
      type: object
      xml:
        name: CarrierForCreation
    CarrierLifecycle:
      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
    CarrierPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyCarrierAction'
          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
    NonDeliveryDaysPerCountryAndProvince:
      type: object
      additionalProperties: false
      properties:
        country:
          type: string
        nonDeliveryDays:
          type: array
          items:
            $ref: '#/components/schemas/NonDeliveryDays'
        recurringNonDeliveryWeekdays:
          type: array
          items:
            $ref: '#/components/schemas/WeekDay'
        nonDeliveryDaysPerProvince:
          type: array
          items:
            $ref: '#/components/schemas/NonDeliveryDaysPerProvince'
      required:
        - country
        - nonDeliveryDays
        - recurringNonDeliveryWeekdays
        - nonDeliveryDaysPerProvince
    NonDeliveryDaysPerProvince:
      type: object
      additionalProperties: false
      properties:
        province:
          type: string
        nonDeliveryDays:
          type: array
          items:
            $ref: '#/components/schemas/NonDeliveryDays'
        recurringNonDeliveryWeekdays:
          type: array
          items:
            $ref: '#/components/schemas/WeekDay'
      required:
        - province
        - nonDeliveryDays
        - recurringNonDeliveryWeekdays
    NonDeliveryDays:
      type: object
      additionalProperties: false
      properties:
        nonDeliveryType:
          $ref: '#/components/schemas/NonDeliveryType'
          default: SINGLE
        nonDeliveryDay:
          type: string
          pattern: ^\d{4}-\d{2}-\d{2}$
          example: '2020-02-03'
      required:
        - nonDeliveryDay
    NonDeliveryType:
      type: string
      enum:
        - SINGLE
        - RECURRING
    SortDirection:
      enum:
        - ASCENDING
        - DESCENDING
      type: string
    SortParameter:
      type: object
      properties:
        sortDirection:
          $ref: '#/components/schemas/SortDirection'
        sortParameterName:
          $ref: '#/components/schemas/SortParameterName'
      required:
        - sortDirection
        - sortParameterName
    SortParameterName:
      enum:
        - NAME
        - ADDRESS
        - STATUS
        - OPERATIVESTATUS
        - SERVICETYPE
        - ORDEREDAMOUNT
        - ORDERDATE
        - ORDERID
      type: string
    CarrierStatus:
      description: 'It is taken into consideration for all carriers. Default: INACTIVE'
      enum:
        - ACTIVE
        - INACTIVE
      type: string
    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
    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
    ConsumerAddress:
      allOf:
        - $ref: '#/components/schemas/Address'
      properties:
        companyName:
          example: Speedy Boxales Ltd.
          type: string
        firstName:
          example: Maxine
          type: string
        lastName:
          example: Muller
          type: string
        salutation:
          example: Frau
          type: string
        email:
          type: string
          minLength: 1
          format: email
          example: test@try.de
        addressType:
          $ref: '#/components/schemas/AddressType'
        coordinates:
          $ref: '#/components/schemas/Coordinates'
      type: object
    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
    Roles:
      description: A list of all rolenames and permissions assigned to the user
      type: array
      items:
        type: object
        properties:
          name:
            $ref: '#/components/schemas/UserRoleNames'
          facilityRefs:
            type: array
            items:
              type: string
          permissions:
            type: array
            items:
              type: string
        required:
          - name
          - permissions
    CustomClaims:
      description: Include all different claims could be assigned to a user
      properties:
        roles:
          $ref: '#/components/schemas/UserRoles'
      required:
        - roles
      type: object
      xml:
        name: 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
    CutoffTime:
      properties:
        hour:
          default: 12
          example: 16
          type: number
        minute:
          default: 0
          example: 30
          type: number
      required:
        - hour
        - minute
      type: object
    TenantConfiguration:
      type: object
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clearName:
          type: string
      required:
        - clearName
    TenantConfigurationForUpsert:
      type: object
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clearName:
          type: string
        version:
          type: number
      required:
        - clearName
        - version
    TransitTimeConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        calculationStrategy:
          type: string
          enum:
            - EARLIEST
            - LATEST
        id:
          type: string
      required:
        - id
        - calculationStrategy
      type: object
    TransitTimeConfigurationForUpsert:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        calculationStrategy:
          type: string
          enum:
            - EARLIEST
            - LATEST
      required:
        - calculationStrategy
      type: object
    CutoffTimeConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        clickAndCollect:
          $ref: '#/components/schemas/CutoffTime'
        shipFromStore:
          $ref: '#/components/schemas/CutoffTime'
        id:
          type: string
      required:
        - shipFromStore
        - clickAndCollect
      type: object
    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
    DeliveryAddressWithType:
      allOf:
        - $ref: '#/components/schemas/DeliveryAddress'
      properties:
        addressType:
          $ref: '#/components/schemas/AddressType'
      required:
        - street
        - houseNumber
        - postalCode
        - city
        - addressType
      type: object
    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
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
      required:
        - street
        - postalCode
        - city
      type: object
    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
    DeliveryNote:
      properties:
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        deliveryAddress:
          description: use this if no deliveryAddresses are passed.
          $ref: '#/components/schemas/DeliveryAddress'
        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
    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
        substituteText:
          $ref: '#/components/schemas/LocaleString'
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        quantityLabel:
          $ref: '#/components/schemas/LocaleString'
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfiguration'
      required:
        - id
        - orderNumberLabel
        - orderDateLabel
        - headline
        - quantityLabel
        - articleIdLabel
        - articleTitleLabel
        - pageLabel
      type: object
    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'
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfigurationForUpsert'
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        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
    DeliveryNoteItem:
      properties:
        id:
          type: string
        quantity:
          type: string
        title:
          type: string
        substitutes:
          type: string
          description: Titel of the item which is substituted through this item
      required:
        - id
        - title
        - quantity
      type: object
    ReturnNote:
      properties:
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        orderInformation:
          $ref: '#/components/schemas/OrderInformation'
        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
        qrCodeContent:
          type: string
        items:
          items:
            $ref: '#/components/schemas/ReturnNoteItem'
          type: array
      required:
        - orderInformation
        - items
      type: object
    ReturnNoteItem:
      properties:
        id:
          type: string
        title:
          type: string
        quantity:
          description: optional parameter for picked quantity of the given line item
          type: integer
        substitutes:
          type: string
          description: Titel of the item which is substituted through this item
      required:
        - title
      type: object
    HandoverJobOrderBy:
      description: STATUS_TARGET_TIME_LAST_MODIFIED_DATE is deprecated
      enum:
        - STATUS_TARGET_TIME_LAST_MODIFIED_DATE
        - TARGET_TIME_ASC
    TenantConnectorConfigurations:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        connectApps:
          type: array
          minItems: 1
          description: All possible apps
          items:
            $ref: '#/components/schemas/TenantConnectorConfiguration'
      required:
        - version
        - connectApps
      type: object
    TenantConnectorConfiguration:
      properties:
        app:
          $ref: '#/components/schemas/ConnectAppTypeEnum'
        firebaseProjectId:
          type: string
          example: some-name
        apiUrl:
          type: string
          example: https://some-name.api.fulfillmenttools.com
        firebaseWebApiKey:
          type: string
          example: GTasGTHJZ_ku_gaad_P2A4KRDQW_MM_-AS-Lglk
        firebaseAppId:
          type: string
          example: 1:180217824890:android:f1fbf11eb8a613cbda9ee4
        firebaseAppIdDebug:
          type: string
          example: 1:180217824890:android:c861c7b58d938e05da9ee4
      additionalProperties: false
      required:
        - app
        - firebaseProjectId
        - apiUrl
        - firebaseWebApiKey
        - firebaseAppId
        - firebaseAppIdDebug
    ConnectAppTypeEnum:
      example: PICKING
      description: The type of possible Apps
      enum:
        - PICKING
        - INVENTORY
        - OPERATIONS_ANDROID
        - OPERATIONS_IOS
      type: string
    CarrierServices:
      example: SIGNATURE
      description: Services which should be booked from carrier
      enum:
        - SIGNATURE
        - CUSTOMER_SIGNATURE
        - ADULT_SIGNATURE
        - SATURDAY_DELIVERY
      type: string
    DHLV2CarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - properties:
            apiKey:
              description: Internal API Key to communicate with the DHL Api
              type: string
            fallback:
              $ref: '#/components/schemas/DHLV2BusinessCredentials'
          required:
            - apiKey
          type: object
      xml:
        name: DhlV2CarrierCredentials
    VceCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - properties:
            user:
              description: Internal user to identify with the VCE Api
              type: string
            password:
              description: Password to authenticate with the VCE Api
              type: string
          required:
            - user
            - password
          type: object
      xml:
        name: VceCarrierCredentials
    DHLV2BusinessCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - properties:
            billingNumber:
              description: >-
                Abrechnungsnummer DHL Paket, displayed in the DHL
                Geschäftskundenportal under 'Vertragspositionen'
              type: string
              example: 22222222220101
              minLength: 1
            retoureBillingNumber:
              description: >-
                Abrechnungsnummer DHL Retoure, displayed in the DHL
                Geschäftskundenportal under 'Vertragspositionen'
              type: string
              example: 22222222220701
              minLength: 1
            internationalBillingNumber:
              description: >-
                Abrechnungsnummer DHL international shipping, displayed in the
                DHL Geschäftskundenportal under 'Vertragspositionen'
              type: string
              example: 22222222220701
              minLength: 1
            dhlBusinessPassword:
              description: Password you use to login to the DHL Geschäftskundenportal
              type: string
              minLength: 1
            dhlBusinessUsername:
              description: >-
                Username (Benutzername) you use to login to the DHL
                Geschäftskundenportal
              type: string
              minLength: 1
            dhlBusinessUsergroup:
              description: (optional) User group to use to obtain a label
              type: string
              minLength: 1
          required:
            - dhlBusinessUsername
            - dhlBusinessPassword
            - billingNumber
          type: object
          xml:
            name: DHLV2BusinessCredentials
    FedexCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - properties:
            accountNumber:
              description: Your fedex accountnumber
              type: string
            apiKey:
              description: Internal API Key to communicate with the CEP Api
              type: string
            secretKey:
              description: Internal API Key to communicate with the CEP Api
              type: string
          required:
            - apiKey
            - secretKey
            - accountNumber
          type: object
      xml:
        name: FedexCarrierCredentials
    BringCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - properties:
            apiUid:
              description: Internal API Uid to communicate with the CEP Api
              type: string
            apiKey:
              description: Internal API Key to communicate with the CEP Api
              type: string
            clientUrl:
              description: Url of the requesting client, can be a static value
              type: string
            authToken:
              description: Identifier for Track&Trace Webhook
              type: string
          required:
            - apiUid
            - apiKey
            - clientUrl
          type: object
      xml:
        name: BringCarrierCredentials
    DomainConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        value:
          description: User's default domain for authentication
          example: yourDomain.com
          type: string
        id:
          type: string
      required:
        - value
      type: object
    TagConfiguration:
      properties:
        offeredDocumentsPerTag:
          type: array
          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'
        offeredDocumentsByDefault:
          type: array
          description: >-
            This configuration is a fallback and applies only if none of the
            entries in offeredDocumentsPerTag can be applied
          items:
            $ref: '#/components/schemas/OfferedDocument'
      required:
        - offeredDocumentsPerTag
        - offeredDocumentsByDefault
    StickerConfiguration:
      additionalProperties: false
      properties:
        offeredStickersByTag:
          type: array
          items:
            $ref: '#/components/schemas/OfferedStickersByTag'
    ExpectedPickLineItemForCreation:
      allOf:
        - $ref: '#/components/schemas/PickLineItemForCreation'
      properties:
        transferId:
          type: string
      required:
        - transferId
    PickLineItemForCreation:
      properties:
        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
        quantity:
          description: quantity of the specific article that has been ordered
          example: 21
          format: int64
          minimum: 1
          type: integer
        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
        measurementValidation:
          $ref: '#/components/schemas/MeasurementValidation'
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        partialStockLocations:
          description: >-
            Indicates where the items to pick could be found and from where the
            picking should be started.
          items:
            $ref: >-
              #/components/schemas/PickJobLineItemPartialStockLocationForCreation
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
        allowedSubstitutes:
          items:
            $ref: '#/components/schemas/Substitute'
          type: array
      required:
        - quantity
        - article
      type: object
    PickRunLineItem:
      allOf:
        - $ref: '#/components/schemas/PickLineItem'
        - properties:
            pickJobRef:
              type: string
    PickLineItem:
      allOf:
        - $ref: '#/components/schemas/PickLineItemForCreation'
        - 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
            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
            pickedAt:
              description: Date when the line has been picked.
              example: '2024-02-03T08:45:51.525Z'
              format: date-time
              type: string
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            substituteLineItems:
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
                  /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
                  under our SLA regulations. For details on this topic please check our
                  <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
              items:
                $ref: '#/components/schemas/SubstituteLineItem'
              type: array
            stockEmptied:
              example: true
              type: boolean
            pickJobLineItemRef:
              example: '12345'
              type: string
              description: used for line items in pick runs to be split up correctly again
            partialStockLocations:
              description: >-
                Indicates where the items to pick could be found and from where
                the picking should be started.
              items:
                $ref: '#/components/schemas/PickJobLineItemPartialStockLocation'
            scannedCodes:
              items:
                $ref: '#/components/schemas/PickLineItemScannedCode'
              type: array
              minimum: 0
            scanningRule:
              deprecated: true
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
                <br /> <i>This endpoint is deprecated and has been
                replaced.</i><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.
              $ref: '#/components/schemas/ScanningRuleConfiguration'
            scanningRules:
              properties:
                scanningMode:
                  $ref: '#/components/schemas/PickingScanningConfigurationEnum'
                scanningType:
                  items:
                    $ref: '#/components/schemas/ScanningRuleValue'
                  type: array
            shortPickReason:
              $ref: '#/components/schemas/PickLineShortPickReason'
          required:
            - id
            - picked
            - status
          type: object
    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
    PickLineShortPickReason:
      additionalProperties: false
      properties:
        reason:
          description: translated reasonLocalized according to the given locale
          type: string
        reasonLocalized:
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
          $ref: '#/components/schemas/LocaleString'
      required:
        - reasonLocalized
    PickingScanningConfigurationEnum:
      example: MUST_SCAN_FIRST
      description: Way in which the scanning of articles during picking is enforced
      enum:
        - MUST_SCAN_FIRST
        - MUST_SCAN_EACH
        - SCAN_NOT_REQUIRED
      type: string
    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
    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
    OfferedStickersByTag:
      additionalProperties: false
      properties:
        tagRef:
          type: string
        matchingValues:
          type: array
          minItems: 1
          items:
            type: string
        stickers:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Sticker'
      required:
        - tagRef
        - matchingValues
        - stickers
      type: object
    Sticker:
      additionalProperties: false
      properties:
        key:
          type: string
          description: unique identifier
          example: LGMl2DuvPnfPoSHhYFOm
        priority:
          description: priority of the given sticker
          example: 100
          format: int64
          maximum: 10000
          minimum: 1
          type: integer
        nameLocalized:
          description: >-
            Dictionary of possible translations, min 1 entry, max 14 characters
            per description
          example: '{ en_US: ''SomeName'' }'
          $ref: '#/components/schemas/LocaleString'
        name:
          description: Translated display name
          type: string
          example: SomeName
        color:
          type: string
          description: optional color coding for the sticker
          example: '#19b6b5'
      required:
        - key
        - nameLocalized
        - priority
    PackJobTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagConfiguration'
        - type: object
          properties:
            stickerConfiguration:
              $ref: '#/components/schemas/StickerConfiguration'
            lineItemStickerConfiguration:
              $ref: '#/components/schemas/StickerConfiguration'
            packJobCreationPerTag:
              type: array
              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'
          required:
            - packJobCreationPerTag
    HandoverJobTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagConfiguration'
      properties:
        stickerConfiguration:
          $ref: '#/components/schemas/StickerConfiguration'
    OrderTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/TagConfiguration'
      properties:
        stickerConfiguration:
          $ref: '#/components/schemas/StickerConfiguration'
    ParcelTagConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        alternativeReturnAddressConfiguration:
          $ref: '#/components/schemas/AlternativeReturnAddressConfiguration'
      required:
        - alternativeReturnAddressConfiguration
      additionalProperties: false
    ParcelTagConfigurationForUpsert:
      properties:
        version:
          type: number
          example: 0
        alternativeReturnAddressConfiguration:
          $ref: '#/components/schemas/AlternativeReturnAddressConfiguration'
      required:
        - alternativeReturnAddressConfiguration
      additionalProperties: false
    AlternativeReturnAddressConfiguration:
      additionalProperties: false
      properties:
        alternativeReturnAddressPerTag:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/AlternativeReturnAddressPerTag'
      required:
        - alternativeReturnAddressPerTag
    AlternativeReturnAddressPerTag:
      properties:
        tagRef:
          type: string
          description: needs to be an existing tag id
        matchingValues:
          type: array
          minItems: 1
          items:
            type: string
        alternativeReturnAddress:
          $ref: '#/components/schemas/FacilityAddress'
      required:
        - tagRef
        - matchingValues
        - alternativeReturnAddress
      additionalProperties: false
    PackJobCreationPerTag:
      properties:
        tagRef:
          type: string
        matchingValues:
          type: array
          items:
            type: string
            minItems: 1
        packJobCreationDisabled:
          type: boolean
      required:
        - packJobCreationDisabled
        - matchingValues
        - tagRef
      type: object
    NeedsPacking:
      properties:
        needsPacking:
          type: boolean
      required:
        - needsPacking
      type: object
    OfferedDocumentPerTag:
      properties:
        tagRef:
          type: string
        matchingValues:
          type: array
          items:
            type: string
            minItems: 1
        offeredDocuments:
          type: array
          items:
            $ref: '#/components/schemas/OfferedDocument'
      required:
        - offeredDocuments
        - matchingValues
        - tagRef
      type: object
    OfferedDocument:
      type: object
      properties:
        documentCategory:
          $ref: '#/components/schemas/DocumentCategory'
      required:
        - documentCategory
    DpdChCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - properties:
            delisId:
              description: Delis ID to create a DPD CH auth token
              type: string
            password:
              description: Password to create a DPD CH auth token
              type: string
          required:
            - delisId
            - password
          type: object
      xml:
        name: DpdChCarrierCredentials
    AngelCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - required:
            - username
            - password
          type: object
          properties:
            username:
              type: string
              description: Angel username
            password:
              type: string
              description: angel password
            authToken:
              type: string
              description: X-Auth-Token for callbacks from Angel
      xml:
        name: AngelCarrierCredentials
    GLSCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - required:
            - username
            - password
            - trackAndTraceUsername
            - trackAndTracePassword
          type: object
          properties:
            username:
              type: string
              description: GLS username
            password:
              type: string
              description: GLS password
            trackAndTraceUsername:
              type: string
              description: GLS Track And Trace username
            trackAndTracePassword:
              type: string
              description: GLS Track And Trace password
      xml:
        name: GLSCarrierCredentials
    PostNLCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractCarrierCredentials'
        - required:
            - apiKey
          type: object
          properties:
            apiKey:
              type: string
              description: PostNL API Key
      xml:
        name: PostNLCarrierCredentials
    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
    Entity:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          description: The id of the entity.
          type: string
      required:
        - id
      type: object
    ApiError:
      items:
        $ref: '#/components/schemas/ErrorInner'
      type: array
      xml:
        name: ApiError
    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
    Facility:
      allOf:
        - $ref: '#/components/schemas/FacilityForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            address:
              $ref: '#/components/schemas/FacilityAddress'
            configs:
              items:
                $ref: '#/components/schemas/LinkedConfiguration'
              type: array
            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
            status:
              $ref: '#/components/schemas/FacilityStatus'
          required:
            - id
            - status
            - address
          type: object
    FacilityAddress:
      allOf:
        - $ref: '#/components/schemas/FacilityAddressForCreation'
        - properties:
            resolvedTimeZone:
              $ref: '#/components/schemas/TimeZone'
          type: object
      type: object
    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
              type: array
            resolvedCoordinates:
              $ref: '#/components/schemas/Coordinates'
              description: >-
                The coordinates correspond to the address of this facility. If
                the coordinates are not provided during the creation or updating
                of the facility, they are automatically resolved by the backend
                system
          required:
            - companyName
          type: object
      type: object
    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
    DeliveryTarget:
      type: string
      description: The destination for a delivery
      enum:
        - SHIP_TO_STORE
        - SHIP_TO_CUSTOMER
    FacilityServiceType:
      type: string
      description: The description of the service this facility offers.
      enum:
        - SHIP_FROM_STORE
        - PICKUP
    FacilityForCreation:
      additionalProperties: false
      properties:
        address:
          $ref: '#/components/schemas/FacilityAddressForCreation'
        closingDays:
          description: >-
            Days of the year where the facility is closed and doesn't allows
            picking
          items:
            $ref: '#/components/schemas/ClosingDay'
          type: array
        contact:
          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
        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:
          default: STORE
          enum:
            - STORE
            - WAREHOUSE
            - EXTERNAL
          type: string
        name:
          example: Hamburg NW2
          type: string
        capacityPlanningTimeframe:
          description: >-
            The range in days per facility which defines how many days in the
            future the capacity of the facility can be planned
          type: integer
          minimum: 1
        pickingTimes:
          $ref: '#/components/schemas/PickingTimes'
          description: >-
            Time ranges defining the picking times per weekday. No overlapping
            ranges are allowed
        pickingMethods:
          description: Picking Methods supported by this facility.
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          type: array
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        services:
          items:
            properties:
              type:
                $ref: '#/components/schemas/FacilityServiceType'
            required:
              - type
            type: object
          type: array
        status:
          $ref: '#/components/schemas/FacilityStatus'
        tenantFacilityId:
          description: The id of the facility in the tenants own system
          example: K12345
          type: string
        capacityEnabled:
          type: boolean
          default: false
          description: >-
            Indicates that configured capacity limits for picking times are
            considered
        tags:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/TagReference'
      required:
        - name
        - address
      type: object
    FacilityPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyFacilityAction'
          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
    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
    FacilityStockConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            id:
              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
            retainedOfflineStock:
              properties:
                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
              type: object
            shortpick:
              properties:
                active:
                  default: true
                  description: >-
                    Inventory adjustment in the case of insufficient order
                    picking
                  type: boolean
              required:
                - active
              type: object
          required:
            - retainedOfflineStock
            - listingReactivationAfter
            - shortpick
            - id
          type: object
    Feature:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        name:
          type: string
        status:
          $ref: '#/components/schemas/FeatureStatus'
      required:
        - name
        - status
      type: object
    FeaturePatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyFeatureAction'
          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
    FeatureStatus:
      enum:
        - enabled
        - inactive
        - disabled
      type: string
    Features:
      properties:
        features:
          items:
            $ref: '#/components/schemas/Feature'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
    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
    FulfillmentProcessBufferConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        minutes:
          default: 240
          description: Duration in minutes until an order is processed
          example: '240'
          minimum: 0
          type: integer
        id:
          type: string
      required:
        - minutes
      type: object
    GdprConfiguration:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        retentionTime:
          description: Number of days after that anonymization is triggered.
          example: 30
          minimum: 1
          type: number
        deletionTimeAfterRetention:
          description: Number of days since anonymization until deletion is triggered
          example: 30
          minimum: 1
          type: number
        version:
          example: 42
          format: int64
          type: integer
        id:
          type: string
      required:
        - retentionTime
        - version
      type: object
    HandoverLineItem:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/HandoverLineItemForCreation'
      properties:
        id:
          type: string
      required:
        - id
    HandoverLineItemForCreation:
      properties:
        refused:
          type: array
          items:
            $ref: '#/components/schemas/RefusedItem'
        article:
          $ref: '#/components/schemas/HandoverLineItemArticle'
        quantity:
          description: quantity of the specific item that has been provided for handover
          example: 21
          format: int64
          minimum: 1
          type: integer
        handedOverQuantity:
          description: quantity of the specific item that has been handed over
          example: 20
          format: int64
          minimum: 0
          type: integer
        substituteLineItems:
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
              /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
              under our SLA regulations. For details on this topic please check our
              <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
          items:
            $ref: '#/components/schemas/HandoverSubstituteLineItem'
          type: array
        tags:
          items:
            $ref: '#/components/schemas/TagReference'
          type: array
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
          type: array
      required:
        - quantity
        - article
        - handedOverQuantity
      type: object
    HandoverLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              type: array
              maxItems: 40
          type: object
      xml:
        name: HandoverLineItemArticle
    HandoverSubstituteLineItem:
      allOf:
        - $ref: '#/components/schemas/SubstituteLineItem'
        - properties:
            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
            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
            refused:
              type: array
              items:
                $ref: '#/components/schemas/RefusedItem'
      required:
        - quantity
        - article
    Handoverjob:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/HandoverjobForCreation'
        - properties:
            handoverJobLineItems:
              items:
                $ref: '#/components/schemas/HandoverLineItem'
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            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
            documents:
              type: array
              items:
                $ref: '#/components/schemas/PrintableDocument'
            stickers:
              type: array
              items:
                $ref: '#/components/schemas/Sticker'
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            carrierKey:
              description: Key of the carrier that is used for this entity
              type: string
      required:
        - id
        - status
      type: object
    HandoverjobForCreation:
      properties:
        carrierLogoUrl:
          description: The URL to the carrier logo
          type: string
        carrierRef:
          type: string
        carrierTrackingNumber:
          description: Tracking number for the created shipment
          type: string
        channel:
          enum:
            - DELIVERY
            - COLLECT
          type: string
        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
        facilityRef:
          description: The id of the facility reference.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        handoverJobLineItems:
          items:
            $ref: '#/components/schemas/HandoverLineItemForCreation'
          type: array
        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: The reference to the parcel.
          example: 2fOge2ZGW54K4TgvDTQw
          type: string
        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
        operativeProcessRef:
          type: string
        shipmentRef:
          description: The reference to the shipment belonging to the handoverjob
          example: Esb20gpHBL94X5NdMp3C
          type: string
        shortIdentifier:
          description: The short identifier of the shipment.
          type: string
        status:
          $ref: '#/components/schemas/HandoverjobStatus'
        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
        paid:
          description: Indicates if the order is already paid
          example: false
          type: boolean
        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.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/TagReference'
        stickers:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Sticker'
        cancelReason:
          $ref: '#/components/schemas/HandoverJobCancelReason'
        invoiceAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        recipientAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        fullIdentifier:
          type: string
          description: An information to identify the recipient
        transfers:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/OperativeTransfer'
      required:
        - facilityRef
        - targetTime
        - channel
        - orderDate
      type: object
    HandoverjobPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyHandoverjobAction'
              - $ref: '#/components/schemas/CancelHandoverjobAction'
          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
    HandoverjobStatus:
      enum:
        - OPEN
        - HANDED_OVER
        - OBSOLETE
        - CANCELED
      type: string
    HandoverJobCancelReason:
      enum:
        - CONSUMER_NO_SHOW
        - CONSUMER_REJECTS
        - ORDER_CANCELED
      type: string
    HandoverConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        availableRefusedReasons:
          items:
            $ref: '#/components/schemas/AvailableRefusedReason'
      type: object
    HandoverConfigurationForCreate:
      additionalProperties: false
      properties:
        version:
          type: number
        availableRefusedReasons:
          items:
            $ref: '#/components/schemas/AvailableRefuseReasonForCreation'
      required:
        - version
      type: object
    AvailableRefusedReason:
      additionalProperties: false
      properties:
        active:
          type: boolean
        refusedReasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        refusedReason:
          description: translated refusedReason selected from refusedReasonLocalized
          example: Broken Item
          type: string
      required:
        - refusedReasonLocalized
        - active
    AvailableRefuseReasonForCreation:
      additionalProperties: false
      properties:
        active:
          type: boolean
          example: true
        refusedReasonLocalized:
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
          $ref: '#/components/schemas/LocaleString'
      required:
        - active
        - refusedReasonLocalized
    AvailableRefuseReasonForUpdate:
      additionalProperties: false
      properties:
        active:
          type: boolean
          example: true
        version:
          type: number
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
        refusedReasonLocalized:
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
          $ref: '#/components/schemas/LocaleString'
      required:
        - active
        - refusedReasonLocalized
        - version
    UpdateRefuseReasonParameter:
      additionalProperties: false
      properties:
        handoverConfigurationVersion:
          type: number
        availableRefuseReasonForUpdate:
          $ref: '#/components/schemas/AvailableRefuseReasonForUpdate'
      required:
        - handoverConfigurationVersion
        - availableRefuseReasonForUpdate
    DeleteRefuseReasonParameter:
      additionalProperties: false
      properties:
        handoverConfigurationVersion:
          type: number
      required:
        - handoverConfigurationVersion
    AddRefuseReasonParameter:
      additionalProperties: false
      properties:
        handoverConfigurationVersion:
          type: number
        availableRefuseReasonForCreation:
          $ref: '#/components/schemas/AvailableRefuseReasonForCreation'
      required:
        - handoverConfigurationVersion
        - availableRefuseReasonForCreation
    LinkedConfiguration:
      properties:
        ref:
          type: string
        rel:
          type: string
      type: object
    Listing:
      allOf:
        - $ref: '#/components/schemas/ListingForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            stockinformation:
              $ref: '#/components/schemas/StockInformation'
              deprecated: true
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
                <br /> <i>This endpoint is deprecated and has been
                replaced.</i><br /><br />@deprecated This field is deprecated
                since 11th of September 2023.

                Use /api/stocks endpoints instead.
            facilityId:
              description: This is a reference to a facility
              example: '4711'
              type: string
            id:
              example: fsfdsf87fsd
              type: string
            status:
              enum:
                - ACTIVE
                - INACTIVE
              type: string
            partialStocks:
              type: array
              deprecated: true
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
                <br /> <i>This endpoint is deprecated and has been
                replaced.</i><br /><br />@deprecated This field is deprecated
                since 11th of September 2023. Use /api/stocks endpoints instead.
              items:
                $ref: '#/components/schemas/PartialStock'
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
          required:
            - status
            - facilityId
            - id
          type: object
      xml:
        name: Listing
    ListingAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      properties:
        keyLocalized:
          $ref: '#/components/schemas/LocaleString'
        valueLocalized:
          $ref: '#/components/schemas/LocaleString'
    BrandForCreation:
      properties:
        name:
          description: The name of the brand for this listing
          type: string
          example: Adidas
      required:
        - name
      type: object
      xml:
        name: BrandForCreation
    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
          type: string
          example: Adidas
      required:
        - name
        - id
      type: object
      xml:
        name: Brand
    StrippedBrands:
      properties:
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
        brands:
          items:
            $ref: '#/components/schemas/Brand'
          type: array
      type: object
    SupportedFilterEntityTypesEnum:
      example: STICKER
      description: Entity types supported as filter entities
      enum:
        - STICKER
      type: string
    FilterEntity:
      properties:
        id:
          example: fsfdsf87fsd
          type: string
        type:
          $ref: '#/components/schemas/SupportedFilterEntityTypesEnum'
        value:
          example: stickerValue
          type: string
        valueLocalized:
          $ref: '#/components/schemas/LocaleString'
      required:
        - valueLocalized
        - id
        - type
      type: object
      xml:
        name: FilterEntity
    StrippedFilterEntities:
      properties:
        total:
          description: Total number of found filter entities for this query
          example: 42
          type: integer
        filterEntities:
          items:
            $ref: '#/components/schemas/FilterEntity'
          type: array
      type: object
    ListingLegal:
      type: object
      additionalProperties: false
      properties:
        hsCode:
          type: string
          maxLength: 50
    ListingForCreation:
      properties:
        attributes:
          items:
            $ref: '#/components/schemas/ListingAttributeItem'
          type: array
          maxItems: 40
        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
        price:
          example: 1200
          type: number
        stockinformation:
          $ref: '#/components/schemas/StockInformationForCreation'
          deprecated: true
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
            <br /> <i>This endpoint is deprecated and has been replaced.</i><br
            /><br />@deprecated This field is deprecated since 11th of September
            2023.

            Use /api/stocks endpoints instead.
        tenantArticleId:
          description: This is a reference to an article Id
          example: '4711'
          type: string
          minLength: 1
        title:
          description: a title describing the article
          example: Adidas Superstar
          type: string
        titleLocalized:
          $ref: '#/components/schemas/LocaleString'
        partialStocks:
          type: array
          deprecated: true
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
            <br /> <i>This endpoint is deprecated and has been replaced.</i><br
            /><br />@deprecated This field is deprecated since 11th of September
            2023.

            Use /api/stocks endpoints instead.
          items:
            $ref: '#/components/schemas/PartialStockForCreation'
        weight:
          type: number
          minimum: 0
        scanningRule:
          $ref: '#/components/schemas/ScanningRuleConfiguration'
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        outOfStockBehaviour:
          enum:
            - BACKORDER
          type: string
        availabilityTimeframe:
          $ref: '#/components/schemas/AvailabilityTimeframe'
        tags:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/TagReference'
        measurementUnitKey:
          description: Identifier for items unit of measurement.
          example: liter
          type: string
        currency:
          description: >-
            The currency of the price as an ISO 4217 code. Attention - Routing
            currently does not convert between different currencies. Don't use
            multiple currencies when using price ratings in order routing.
          example: EUR
          nullable: true
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
        stockProperties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/StockPropertyDefinition'
        stockAvailableUntil:
          $ref: '#/components/schemas/AvailableUntilDefinition'
        legal:
          $ref: '#/components/schemas/ListingLegal'
        customAttributes:
          nullable: 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.
          type: object
      required:
        - tenantArticleId
        - title
      type: object
      xml:
        name: ListingForCreation
    PickingStockProperty:
      additionalProperties:
        type: string
      example:
        color: yellow
      type: object
    PickingStockPropertyPreset:
      type: object
      properties:
        expiry:
          type: string
    StockPropertyDefinition:
      properties:
        inputType:
          $ref: '#/components/schemas/StockPropertyInputType'
        required:
          description: Indicates if this property is required.
          type: boolean
        defaultValue:
          description: |-
            <i><center>
              <img src='https://storage.googleapis.com/ocff-assets/api/fft-alpha_174x51.png'/>
              </center> <br /> 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 disappear also without warning. Thus, it currently does not fall
              under our SLA regulations. For details on this topic please check our
              <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a>
              </i><br /><br />If {{NOW}} is provided, this will be replaced with a timestamp.
          type: string
      required:
        - inputType
        - required
      type: object
    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.
          type: string
          pattern: ^-?P(?:(\d+W)|(\d+Y)?(\d+M)?(\d+D)?(?:T(\d+H)?(\d+M)?(\d+S)?)?)$
          example: '-P30D'
      required:
        - calculationBase
    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
    AvailabilityTimeframe:
      properties:
        start:
          example: '2020-02-03T08:45:50.525Z'
          format: date-time
          type: string
      type: object
    ListingForReplacement:
      allOf:
        - $ref: '#/components/schemas/ListingForCreation'
      properties:
        version:
          example: 42
          format: int64
          type: integer
        status:
          enum:
            - ACTIVE
            - INACTIVE
          type: string
      type: object
      xml:
        name: ListingForReplacement
    ListingPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyListingAction'
          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
    ListingsForCreation:
      properties:
        listings:
          items:
            $ref: '#/components/schemas/ListingForCreation'
          minItems: 1
          type: array
      required:
        - listings
      type: object
      xml:
        name: ListingsForCreation
    ListingsForReplacement:
      properties:
        listings:
          items:
            $ref: '#/components/schemas/ListingForReplacement'
          minItems: 1
          maxItems: 500
          type: array
      required:
        - listings
      type: object
      xml:
        name: ListingsForReplacement
    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
      type: object
    LoadUnit:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/LoadUnitForCreation'
      properties:
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        weightLimitInG:
          description: 'Maximal weight in gramm(gr) the loadunit can handle. '
          type: number
          minimum: 1
        description:
          type: string
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        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:
          type: string
        name:
          type: string
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        loadUnitLineItems:
          type: array
          items:
            $ref: '#/components/schemas/LoadUnitLineItem'
      required:
        - id
        - nameLocalized
        - version
        - facilityRef
      type: object
    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
    LoadUnitLineItemForCreation:
      properties:
        article:
          $ref: '#/components/schemas/PickLineItemArticle'
        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
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
      required:
        - article
    LoadUnitLineItem:
      allOf:
        - $ref: '#/components/schemas/LoadUnitLineItemForCreation'
      properties:
        id:
          type: string
      required:
        - id
    LoadUnitForCreation:
      properties:
        codes:
          items:
            description: List of codes
            type: string
          type: array
        loadUnitTypeRef:
          type: string
          deprecated: true
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
            <br /> <i>This endpoint is deprecated and has been replaced.</i><br
            /><br />Use operativeContainerTypeRef instead.
        loadUnitLineItems:
          type: array
          items:
            $ref: '#/components/schemas/LoadUnitLineItemForCreation'
        pickJobRefs:
          items:
            description: List of corresponding pickjob Ids
            type: string
          maxItems: 1
          minItems: 1
          type: array
        customAttributes:
          description: >-
            Attributes that can be added to the LoadUnit. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the informations carried here.
          type: object
        storageLocationRef:
          description: >-
            the reference to the storage location this load unit as been placed
            into
          type: string
        operativeContainerTypeRef:
          description: the reference to the operativeContainerType
          type: string
        stackRef:
          description: the reference to the stackRef this loadUnit is part of
          type: string
      required:
        - pickJobRefs
      type: object
    Stack:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/StackForCreation'
      properties:
        id:
          type: string
        version:
          type: integer
          format: int64
          example: 42
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
        created:
          type: string
          format: date-time
          example: '2020-02-03T08:45:51.525Z'
          description: >-
            The date this entity was created at the platform. This value is
            generated by the service.
        lastModified:
          type: string
          format: date-time
          example: '2020-02-03T09:45:51.525Z'
          description: >-
            The date this entity was modified last. This value is generated by
            the service.
      type: object
      required:
        - id
        - version
        - created
        - lastModified
        - facilityRef
        - processRef
    StackForCreation:
      additionalProperties: false
      properties:
        facilityRefs:
          description: Linked Facilities through reference
          type: array
          items:
            type: string
        processRefs:
          description: Linked Processes through reference
          type: array
          items:
            type: string
      type: object
      required:
        - facilityRefs
        - processRefs
    PickingLoadUnit:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - $ref: '#/components/schemas/PickingLoadUnitForCreation'
      properties:
        description:
          type: string
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        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:
          type: string
        name:
          type: string
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        loadUnitLineItems:
          type: array
          items:
            $ref: '#/components/schemas/LoadUnitLineItem'
      required:
        - id
        - nameLocalized
        - version
        - facilityRef
      type: object
    PickingLoadUnitForCreation:
      properties:
        codes:
          items:
            description: List of codes
            type: string
          type: array
          minItems: 1
        loadUnitTypeRef:
          type: string
        loadUnitLineItems:
          type: array
          items:
            $ref: '#/components/schemas/LoadUnitLineItemForCreation'
        customAttributes:
          description: >-
            Attributes that can be added to the PickingLoadUnit. These
            attributes cannot be used within fulfillment processes, but it could
            be useful to have the informations carried here.
          type: object
        storageLocationRef:
          description: >-
            the reference to the storage location this load unit as been placed
            into
          type: string
        operativeContainerTypeRef:
          description: the reference to the operativeContainerType
          type: string
        stackRef:
          description: the reference to the stackRef this loadUnit is part of
          type: string
      required:
        - codes
      type: object
    LoadUnitType:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        weightLimitInG:
          description: 'Maximal weight in gramm(gr) the loadunit can handle. '
          type: number
          minimum: 1
        description:
          type: string
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        iconUrl:
          description: ''
          type: string
        id:
          description: ''
          type: string
        name:
          type: string
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        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
      required:
        - id
        - version
        - nameLocalized
      type: object
    LoadUnitTypeForCreation:
      additionalProperties: false
      properties:
        dimensions:
          $ref: '#/components/schemas/LoadUnitDimensions'
        weightLimitInG:
          description: 'Maximal weight in gramm(gr) the loadunit can handle. '
          type: number
          minimum: 1
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        icon:
          $ref: '#/components/schemas/NamedFile'
          description: ''
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        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
      required:
        - nameLocalized
      type: object
    LoadUnitTypePatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ModifyLoadUnitTypeAction'
          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: LoadUnitTypePatchActions
    LoadUnitTypes:
      items:
        $ref: '#/components/schemas/LoadUnitType'
      type: array
    LoadUnits:
      properties:
        loadUnits:
          items:
            $ref: '#/components/schemas/LoadUnit'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      type: object
    LoadUnitsForCreation:
      properties:
        loadUnits:
          items:
            $ref: '#/components/schemas/LoadUnitForCreation'
          minItems: 1
          type: array
      required:
        - loadUnits
      type: object
    PackingSourceContainerForCreation:
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        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'
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        packJobRefs:
          type: array
          minItems: 1
          description: List of references to packJobs
          items:
            type: string
            example: 0857914c-d965-421e-b6cf-330501bcca58
        codes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
          minItems: 1
      required:
        - packJobRefs
        - nameLocalized
        - facilityRef
      type: object
    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
    StrippedPackingSourceContainer:
      additionalProperties: false
      type: object
      properties:
        id:
          type: string
          example: c7467ba8-c28a-4473-8748-a4e54e675e4c
        loadUnitRef:
          type: string
          example: 2357914c-d965-421e-b6cf-330501bccaab
        codes:
          items:
            description: Codes, that identify the container
            type: string
          type: array
          minItems: 1
    PackingSourceContainer:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        descriptionLocalized:
          $ref: '#/components/schemas/LocaleString'
        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
        iconUrl:
          description: ''
          type: string
        description:
          type: string
        name:
          type: string
        id:
          type: string
          example: c7467ba8-c28a-4473-8748-a4e54e675e4c
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        packJobRefs:
          type: array
          minItems: 1
          description: List of references to packJobs
          items:
            type: string
            example: 0857914c-d965-421e-b6cf-330501bcca58
        loadUnitRef:
          type: string
          example: 2357914c-d965-421e-b6cf-330501bccaab
        codes:
          items:
            description: Codes, that identify the container
            type: string
          type: array
          minItems: 1
      additionalProperties: false
      required:
        - packJobRefs
        - nameLocalized
        - facilityRef
        - id
        - version
        - lastModified
        - created
      type: object
    LocaleConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        locale:
          $ref: '#/components/schemas/SupportedLocale'
        countryLanguageMapping:
          $ref: '#/components/schemas/CountryLanguageMapping'
        id:
          type: string
      required:
        - locale
      type: object
    CountryLanguageMapping:
      additionalProperties:
        type: string
      example:
        DE: de_DE
        US: en_US
        RU: ru_RU
      type: object
    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
    MeasurementUnitForCreation:
      properties:
        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
        nameLocalized:
          $ref: '#/components/schemas/LocaleString'
        requiresMeasurement:
          description: Indicates that the given unit need to be measured.
          example: true
          type: boolean
      required:
        - nameLocalized
        - abbreviationLocalized
        - key
      type: object
    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
    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
        province:
          example: Nordrhein-Westfalen
          pattern: ^.+$
          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
          type: array
        postalCode:
          example: '40764'
          pattern: ^.+$
          type: string
        street:
          example: Hauptstr.
          pattern: ^.+$
          type: string
        resolvedCoordinates:
          $ref: '#/components/schemas/Coordinates'
      type: object
    ModifyCarrierAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyCarrierAction', because you want to modify a
                carrier
              enum:
                - ModifyCarrier
              type: string
            defaultParcelWeightInGram:
              description: Default weight for a parcel in gram
              default: 1000
              minimum: 1
              type: number
            defaultParcelWidthInCm:
              description: Default width in cm
              default: 35
              minimum: 1
              type: number
            defaultParcelLengthInCm:
              description: Default length in cm
              default: 25
              minimum: 1
              type: number
            defaultParcelHeightInCm:
              description: Default height in cm
              default: 10
              minimum: 1
              type: number
            parcelLabelClassifications:
              items:
                $ref: '#/components/schemas/ParcelLabelClassificationForCreation'
              type: array
            credentials:
              $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
            deliveryType:
              $ref: '#/components/schemas/CarrierDeliveryType'
            lifecycle:
              $ref: '#/components/schemas/CarrierLifecycle'
            logoUrl:
              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
            status:
              $ref: '#/components/schemas/CarrierStatus'
            productValueNeeded:
              type: boolean
              example: true
              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)
          required:
            - action
          type: object
      xml:
        name: ModifyCarrierAction
    ModifyDpdChCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - additionalProperties: false
          properties:
            delisId:
              description: Delis ID to create a DPD CH auth token.
              type: string
            key:
              description: Use value 'DPD_CH' in order to provide DPD credentials
              type: string
            password:
              description: Password to create a DPD CH auth token.
              type: string
          required:
            - key
          type: object
      xml:
        name: ModifyDpdChCarrierCredentials
    ModifyPostNLCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - additionalProperties: false
          properties:
            apiKey:
              description: Key to access the postNl api.
              type: string
            key:
              description: Use value 'POSTNL' in order to provide POSTNL credentials
              type: string
          required:
            - key
          type: object
      xml:
        name: ModifyPostNLCarrierCredentials
    ModifyBringCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - additionalProperties: false
          properties:
            apiUid:
              type: string
              description: Internal API Uid to communicate with the CEP Api
            apiKey:
              type: string
              description: Internal API Key to communicate with the CEP Api
            clientUrl:
              type: string
              description: Url of the requesting client, can be a static value
            authToken:
              type: string
              description: Identifier for Track&Trace Webhook
            key:
              description: Use value 'BRING' in order to provide BRING credentials
              type: string
          required:
            - key
          type: object
      xml:
        name: ModifyBringCarrierCredentials
    ModifyDHLV2CarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - additionalProperties: false
          properties:
            apiKey:
              description: Internal API Key to communicate with the DHL Api
              type: string
              minLength: 1
            fallback:
              $ref: '#/components/schemas/DHLV2BusinessCredentials'
          required:
            - key
            - apiKey
          type: object
      xml:
        name: ModifyDHLV2CarrierCredentials
    ModifyFedexCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - properties:
            accountNumber:
              description: Your fedex accountnumber
              type: string
            apiKey:
              description: Internal API Key to communicate with the CEP Api
              type: string
            secretKey:
              description: Internal API Key to communicate with the CEP Api
              type: string
            key:
              description: Use value 'FEDEX' in order to provide FEDEX credentials
              type: string
          required:
            - key
          type: object
      xml:
        name: ModifyFedexCarrierCredentials
    ModifyAngelCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - properties:
            username:
              description: Your Angel username
              type: string
            password:
              description: Your password for Angel carrier
              type: string
            authToken:
              description: X-Auth-Token for callbacks from Angel
              type: string
            key:
              description: Use value 'ANGEL' in order to provide ANGEL credentials
              type: string
          required:
            - key
          type: object
      xml:
        name: ModifyAngelCarrierCredentials
    ModifyGLSCarrierCredentials:
      allOf:
        - $ref: '#/components/schemas/AbstractModifyCarrierCredentials'
        - properties:
            username:
              description: Your Angel username
              type: string
            password:
              description: Your password for Angel carrier
              type: string
            trackAndTraceUsername:
              description: GLS Track And Trace username
              type: string
            trackAndTracePassword:
              description: GLS Track And Trace password
              type: string
            key:
              description: Use value 'GLS' in order to provide GLS credentials
              type: string
          required:
            - key
          type: object
      xml:
        name: ModifyGLSCarrierCredentials
    ModifyFacilityAction:
      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'
            closingDays:
              description: >-
                Days of the year where the facility is closed and doesn't allows
                picking
              items:
                $ref: '#/components/schemas/ClosingDay'
              type: array
            contact:
              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
            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:
              enum:
                - STORE
                - WAREHOUSE
                - EXTERNAL
              type: string
            name:
              example: Hamburg NW2
              type: string
            capacityPlanningTimeframe:
              description: >-
                The range in days per facility which defines how many days in
                the future the capacity of the facility can be planned
              type: integer
              minimum: 1
            pickingTimes:
              $ref: '#/components/schemas/PickingTimes'
              description: >-
                Time ranges defining the picking times per weekday. No
                overlapping ranges are allowed
            pickingMethods:
              description: Picking Methods supported by this facility.
              items:
                $ref: '#/components/schemas/PickingMethodEnum'
              type: array
            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
            capacityEnabled:
              type: boolean
            tags:
              type: array
              minItems: 0
              items:
                $ref: '#/components/schemas/TagReference'
          required:
            - action
          type: object
      xml:
        name: ModifyFacilityAction
    AbstractFacilityActionsParameter:
      discriminator:
        propertyName: name
      properties:
        name:
          type: string
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    UpdateFacilityCoordinatesActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractFacilityActionsParameter'
      properties:
        name:
          enum:
            - UPDATE_FACILITY_COORDINATES
          type: string
        coordinates:
          $ref: '#/components/schemas/Coordinates'
      required:
        - name
        - coordinates
        - version
    RemoveFacilityCoordinatesActionParameter:
      allOf:
        - $ref: '#/components/schemas/AbstractFacilityActionsParameter'
      properties:
        name:
          enum:
            - REMOVE_FACILITY_COORDINATES
          type: string
      required:
        - name
        - version
    FacilityActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/RemoveFacilityCoordinatesActionParameter'
        - $ref: '#/components/schemas/UpdateFacilityCoordinatesActionParameter'
    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
    ModifyParcelAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'ModifyParcel', because you want to modify a Parcel
              enum:
                - ModifyParcel
              type: string
            status:
              $ref: '#/components/schemas/ParcelStatus'
            result:
              $ref: '#/components/schemas/ParcelResult'
            customAttributes:
              type: object
            dimensions:
              $ref: '#/components/schemas/ParcelDimensions'
            productValue:
              nullable: true
              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
              type: number
              example: 12.5
            pickUpInformation:
              $ref: '#/components/schemas/ParcelPickUpInformation'
            services:
              $ref: '#/components/schemas/ParcelServices'
            carrierProduct:
              nullable: true
              type: string
              description: Only changable on status OPEN or FAILED of the existing Parcel
          required:
            - action
          type: object
      xml:
        name: ModifyParcelAction
    ModifyParcelLoadUnitsAction:
      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:
              type: array
              items:
                type: string
          required:
            - action
            - loadUnitRefs
          type: object
      xml:
        name: ModifyParcelLoadUnitsAction
    ReplaceLoadUnitLineItemsAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ReplaceLoadUnitLineItems', because you want to
                replace loadunit line items
              enum:
                - ReplaceLoadUnitLineItems
              type: string
            loadUnitLineItems:
              type: array
              items:
                $ref: '#/components/schemas/LoadUnitLineItem'
          required:
            - action
            - loadUnitLineItems
          type: object
      xml:
        name: ReplaceLoadUnitLineItemsAction
    ParcelPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyParcelAction'
              - $ref: '#/components/schemas/ModifyParcelLoadUnitsAction'
          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
    LoadUnitPatchActions:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ReplaceLoadUnitLineItemsAction'
          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: LoadUnitPatchActions
    ModifyFeatureAction:
      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: ModifyFeatureAction
    ModifyHandoverjobAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyHandoverjob', because you want to modify a
                handoverjob
              enum:
                - ModifyHandoverjob
              type: string
            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
          type: object
      xml:
        name: ModifyHandoverjobAction
    CancelHandoverjobAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/handoverjobs/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'CancelHandoverjob', because you want to cancel a
                handover job
              enum:
                - CancelHandoverjob
              type: string
            handoverJobCancelReason:
              $ref: '#/components/schemas/HandoverJobCancelReason'
          required:
            - action
            - handoverJobCancelReason
          type: object
      xml:
        name: CancelHandoverjobAction
    ModifyListingAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            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'
              type: array
              maxItems: 40
            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
            price:
              example: 1200
              type: number
            currency:
              description: >-
                The currency of the price as an ISO 4217 code. Attention -
                Routing currently does not convert between different currencies.
                Don't use multiple currencies when using price ratings in order
                routing.
              example: EUR
              nullable: true
              allOf:
                - $ref: '#/components/schemas/CurrencyCode'
            status:
              description: The status indicates if a listing is available or not
              enum:
                - ACTIVE
                - INACTIVE
              type: string
            stockinformation:
              $ref: '#/components/schemas/StockInformationForCreation'
              deprecated: true
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
                <br /> <i>This endpoint is deprecated and has been
                replaced.</i><br /><br />@deprecated This field is deprecated
                since 11th of September 2023. Use /api/stocks endpoints instead.
            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
            titleLocalized:
              $ref: '#/components/schemas/LocaleString'
            tags:
              type: array
              minItems: 0
              items:
                $ref: '#/components/schemas/TagReference'
            scanningRule:
              $ref: '#/components/schemas/ScanningRuleConfiguration'
            scannableCodes:
              items:
                description: Codes, that identify the article
                type: string
              type: array
            weight:
              type: number
            outOfStockBehaviour:
              enum:
                - BACKORDER
              type: string
            availabilityTimeframe:
              $ref: '#/components/schemas/AvailabilityTimeframe'
            measurementUnitKey:
              type: string
              nullable: true
              example: kg
            stockProperties:
              type: object
              nullable: true
              additionalProperties:
                $ref: '#/components/schemas/StockPropertyDefinition'
            stockAvailableUntil:
              $ref: '#/components/schemas/AvailableUntilDefinition'
            legal:
              $ref: '#/components/schemas/ListingLegal'
            customAttributes:
              nullable: 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.
              type: object
          required:
            - action
          type: object
      xml:
        name: ModifyListingAction
    ModifyListingReactivationAfterAction:
      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
      xml:
        name: ModifyListingReactivationAfterAction
    ModifyLoadUnitTypeAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyLoadUnitType', because you want to modify a
                LoadUnitType
              enum:
                - ModifyLoadUnitType
              type: string
            descriptionLocalized:
              $ref: '#/components/schemas/LocaleString'
            nameLocalized:
              $ref: '#/components/schemas/LocaleString'
            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
            dimensions:
              $ref: '#/components/schemas/LoadUnitDimensions'
            weightLimitInG:
              description: 'Maximal weight in gramm(gr) the loadunit can handle. '
              type: number
              minimum: 1
          required:
            - action
          type: object
      xml:
        name: ModifyLoadUnitTypeAction
    RestartPickJobAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/pickjobs/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - 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
      xml:
        name: RestartPickJobAction
    ResetPickJobAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/pickjobs/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ResetPickJobAction' 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
      xml:
        name: ResetPickJobAction
    ModifyPickJobLastEditorAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyPickJobLastEditorAction' to set the last editor
                to your user and therefor take over the pickjob.
              enum:
                - ModifyPickJobLastEditor
              type: string
          required:
            - action
          type: object
      xml:
        name: ModifyPickJobLastEditorAction
    ModifyPickJobAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'ModifyPickJob', because you want to modify a pickjob
              enum:
                - ModifyPickJob
              type: string
            preferredPickingMethods:
              description: Preferred way of picking a given pickJob.
              items:
                $ref: '#/components/schemas/PickingMethodEnum'
              type: array
            paymentInformation:
              $ref: '#/components/schemas/PaymentInformation'
            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
            status:
              $ref: '#/components/schemas/PickJobStatusUnprotected'
          required:
            - action
          type: object
      xml:
        name: ModifyPickJobAction
    AbortPickJobAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/pickjobs/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'AbortPickJob', because you want to cancel a pickjob
              enum:
                - AbortPickJob
              type: string
          required:
            - action
          type: object
      xml:
        name: AbortPickJobAction
    ModifyPickLineItemAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyPickLineItem', because you want to modify a
                pick line item
              enum:
                - ModifyPickLineItem
              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
            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
            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
            stockEmptied:
              example: true
              type: boolean
            stickers:
              items:
                $ref: '#/components/schemas/Sticker'
              type: array
            partialStockLocations:
              items:
                $ref: >-
                  #/components/schemas/PickJobLineItemPartialStockLocationForUpdate
            scannedCodes:
              description: Scanned Codes of the given picked line item
              items:
                $ref: '#/components/schemas/PickLineItemScannedCode'
              minItems: 0
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            secondaryPicked:
              type: integer
            substituteLineItems:
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
                  /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
                  under our SLA regulations. For details on this topic please check our
                  <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
              items:
                $ref: '#/components/schemas/SubstituteLineItemForCreation'
              type: array
            shortPickReasonLocalized:
              description: Localized reason
              example: '{ en_US: ''SomeName'' }'
              nullable: true
              $ref: '#/components/schemas/LocaleString'
          required:
            - id
            - action
          type: object
          additionalProperties: false
      xml:
        name: ModifyPickLineItemAction
    ModifyRetainedOfflineStockAction:
      deprecated: true
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyRetainedOfflineStock', if you want to modify
                the retained offline stocks of a facility
              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
      xml:
        name: ModifyRetainedOfflineStockAction
    ModifyReturnAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              enum:
                - ModifyReturn
              type: string
            status:
              $ref: '#/components/schemas/ReturnStatus'
          required:
            - action
          type: object
      xml:
        name: ModifyReturnAction
    ModifyReturnLineItemAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - properties:
            action:
              description: >-
                Use value 'ModifyReturnLineItem', because you want to modify a
                return line item
              enum:
                - ModifyReturnLineItem
              type: string
            id:
              description: Id of the return line item you want to update
              type: string
            returned:
              $ref: '#/components/schemas/Returned'
            status:
              $ref: '#/components/schemas/ReturnLineStatus'
          required:
            - id
            - action
            - returned
          type: object
      xml:
        name: ModifyReturnLineItemAction
    ModifyShipmentAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'ModifyShipment', because you want to modify a
                shipment
              enum:
                - ModifyShipment
              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
            carrierProduct:
              description: Desired product of given carrier to choose when ordering a label
              type: string
              example: EXPRESS
            pickJobRef:
              description: >-
                The reference to the pickjob for which the shipment is assigned
                to
              example: ca525716-7208-4a63-a2a6-11274eb37f67-0
              type: string
            paymentInformation:
              $ref: '#/components/schemas/PaymentInformation'
            status:
              $ref: '#/components/schemas/ShipmentStatus'
            targetAddress:
              $ref: '#/components/schemas/ConsumerAddress'
          required:
            - action
          type: object
      xml:
        name: ModifyShipmentAction
    ModifyShortpickAction:
      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
      xml:
        name: ModifyShortpickAction
    ModifyUserAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'ModifyUser', because you want to modify a user
              enum:
                - ModifyUser
              type: string
            firstname:
              example: Alex
              type: string
            lastname:
              example: Schneider
              type: string
            locale:
              $ref: '#/components/schemas/SupportedLocale'
            password:
              example: fsdf6556
              minLength: 6
              type: string
            roles:
              $ref: '#/components/schemas/UserRoles'
            assignedFacilities:
              items:
                $ref: '#/components/schemas/UserAssignedFacilityForCreation'
              type: array
            customAttributes:
              nullable: true
              description: >-
                Attributes that can be added to the user. These attributes
                **cannot** be used within fulfillment processes, but enable you
                to attach custom data from your systems to fulfillmenttools
                entities.
              type: object
          required:
            - action
          type: object
      xml:
        name: ModifyUserAction
    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
    MeasurementValidation:
      properties:
        shortPickSoftTolerancePercentage:
          description: Allowed soft short pick deviation tolerance.
          example: 10
          minimum: 0
          maximum: 100
          type: number
        shortPickHardTolerancePercentage:
          description: Allowed hard short pick deviation tolerance.
          example: 15
          minimum: 0
          maximum: 100
          type: number
        overPickSoftTolerancePercentage:
          description: Allowed soft over pick deviation tolerance.
          example: 15
          minimum: 0
          type: number
        overPickHardTolerancePercentage:
          description: Allowed hard over pick deviation tolerance.
          example: 20
          minimum: 0
          type: number
    OrderStatus:
      description: The state of the order. Initially it is OPEN.
      enum:
        - OPEN
        - CANCELLED
        - PROMISED
        - LOCKED
        - OBSOLETE
      type: string
    ParcelDimensions:
      additionalProperties: false
      nullable: true
      properties:
        height:
          description: The height of the package (in cm)
          example: 50
          type: number
        length:
          description: The length of the package (in cm)
          example: 100
          type: number
        weight:
          description: The weight of the package (in g)
          example: 1700
          type: number
        width:
          description: The width of the package (in cm)
          example: 25
          type: number
      type: object
    ParcelServices:
      additionalProperties: false
      nullable: true
      properties:
        bulkyGoods:
          type: boolean
        signature:
          description: Signature from anyone needed
          type: boolean
        adultSignature:
          description: Signature from some adult
          type: boolean
        customerSignature:
          description: Signature from the ordering customer needed
          type: boolean
        saturdayDelivery:
          description: Saturday Delivery
          type: boolean
    Parcel:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            carrierRef:
              description: Reference to the carrier this parcel should be send by
              example: cf00e102-34f2-45c1-a846-6a21f384321e
              type: string
            carrierProduct:
              description: Desired product of given carrier to choose when ordering a label
              type: string
              example: EXPRESS
            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
            dimensions:
              $ref: '#/components/schemas/ParcelDimensions'
            services:
              $ref: '#/components/schemas/ParcelServices'
            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
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            loadUnitRefs:
              description: Reference to array of load unit Refs
              items:
                type: string
              type: array
            recipient:
              $ref: '#/components/schemas/ConsumerAddress'
            invoice:
              $ref: '#/components/schemas/ConsumerAddress'
            processRef:
              type: string
            facilityRef:
              type: string
            operativeProcessRef:
              type: string
            items:
              items:
                $ref: '#/components/schemas/ParcelItem'
              type: array
            postalCharges:
              $ref: '#/components/schemas/ParcelPostalCharge'
            returnAddress:
              $ref: '#/components/schemas/FacilityAddress'
            result:
              $ref: '#/components/schemas/ParcelResult'
            sender:
              $ref: '#/components/schemas/FacilityAddress'
            shipmentRef:
              description: The id of this shipment this parcel has been created for.
              example: 95EWrieX09OmeriXIUbb
              type: string
            status:
              $ref: '#/components/schemas/ParcelStatus'
            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
              type: number
              example: 12.5
            productValueCurrency:
              $ref: '#/components/schemas/ProductValueCurrency'
            productValueType:
              $ref: '#/components/schemas/ProductValueType'
            shortId:
              type: string
              example: AA12-1
            transfers:
              type: array
              minItems: 0
              items:
                $ref: '#/components/schemas/OperativeTransfer'
          required:
            - id
            - status
            - carrierRef
            - processRef
            - sender
            - recipient
            - loadUnitRefs
          type: object
    ParcelForCreation:
      additionalProperties: false
      properties:
        status:
          $ref: '#/components/schemas/ParcelStatus'
        carrierProduct:
          description: Desired product of given carrier to choose when ordering a label
          type: string
          example: EXPRESS
        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
        dimensions:
          $ref: '#/components/schemas/ParcelDimensions'
        services:
          $ref: '#/components/schemas/ParcelServices'
        loadUnitRefs:
          description: Reference to array of load unit Refs
          items:
            type: string
          type: array
        items:
          items:
            $ref: '#/components/schemas/ParcelItemForCreation'
          type: array
        recipient:
          $ref: '#/components/schemas/ConsumerAddress'
        invoice:
          $ref: '#/components/schemas/ConsumerAddress'
        sender:
          $ref: '#/components/schemas/FacilityAddress'
        returnAddress:
          $ref: '#/components/schemas/FacilityAddress'
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        pickUpInformation:
          $ref: '#/components/schemas/ParcelPickUpInformation'
        shortId:
          type: string
          example: AA12-1
        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
          type: number
          example: 12.5
        productValueCurrency:
          $ref: '#/components/schemas/ProductValueCurrency'
        productValueType:
          $ref: '#/components/schemas/ProductValueType'
        result:
          $ref: '#/components/schemas/ParcelResult'
        transfers:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/OperativeTransfer'
      type: object
    ProductValueCurrency:
      additionalProperties: false
      properties:
        currency:
          type: string
          description: Currency of the given value
          example: EUR
        decimalPlaces:
          type: integer
          description: Number of decimal places for the given currency
          example: 2
      required:
        - currency
      type: object
    ProductValueType:
      additionalProperties: false
      enum:
        - INSURANCE
        - CUSTOMS
        - SHOP_PRICE
      type: string
      example: INSURANCE
    ParcelItemForCreation:
      properties:
        quantity:
          type: integer
          minimum: 1
          description: amount of the given items
          example: 5
        hsCode:
          type: string
          maxLength: 50
        description:
          description: Description of the given item/items
          example: Item Description
          type: string
        weightInGram:
          type: integer
          description: Weight of a single item in gram
          example: 10000
        parcelItemValue:
          $ref: '#/components/schemas/ParcelItemValue'
        countryOfManufacture:
          type: string
        article:
          $ref: '#/components/schemas/ParcelItemArticle'
      required:
        - quantity
      type: object
      xml:
        name: 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
        parcelItemValue:
          $ref: '#/components/schemas/ParcelItemValue'
        parcelItemArticleAttributes:
          items:
            $ref: '#/components/schemas/ArticleAttributeItem'
          type: array
          maxItems: 40
        weightInGram:
          type: integer
          nullable: true
          description: Weight of a single item in gram
          example: 10000
      required:
        - id
      type: object
    ParcelArticleAttributeItemForUpdate:
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
      required:
        - key
        - value
        - category
    ParcelPickUpInformation:
      additionalProperties: false
      nullable: true
      properties:
        startTime:
          description: needs to be before end time
          format: date-time
          type: string
        endTime:
          description: needs to be after start time
          format: date-time
          type: string
      required:
        - startTime
        - endTime
      xml:
        name: ParcelItemForCreation
    ParcelPostalCharge:
      properties:
        value:
          type: number
          description: Monetary Value in the given currency
          example: 15.5
        currency:
          type: string
          description: Currency of the given value
          example: EUR
      required:
        - currency
        - value
    ParcelItem:
      properties:
        id:
          description: The id of this parcelItem.
          example: ae3ba67c-a42c-4816-96ac-16231e49640c
          type: string
        quantity:
          type: integer
          minimum: 1
          description: amount of the given items
          example: 5
        hsCode:
          deprecated: true
          description: Deprecated - use article.attribute.hsCode instead
          type: string
          maxLength: 50
        description:
          deprecated: true
          description: >-
            Description - article.title will be used instead - of the given
            item/items
          example: Item Description
          type: string
        weightInGram:
          deprecated: true
          type: integer
          description: >-
            Deprecated - use article.attribute.weightPerUnit instead - Weight of
            a single item in gram
          example: 10000
        parcelItemValue:
          deprecated: true
          description: >-
            Deprecated - use article.attribute.pricePerUnit and
            article.attribute.currency instead
          $ref: '#/components/schemas/ParcelItemValue'
        countryOfManufacture:
          deprecated: true
          description: Deprecated - use article.attribute.countryOfManufacture instead
          type: string
        article:
          $ref: '#/components/schemas/ParcelItemArticle'
      required:
        - id
        - quantity
      type: object
      xml:
        name: ParcelItem
    ParcelItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              type: array
              maxItems: 40
          type: object
      xml:
        name: ParcelItemArticle
    ParcelItemValue:
      nullable: true
      description: >-
        deprecated, use
        MandatoryShippingArticleAttribute.attributes.pricePerUnit instead
      properties:
        value:
          type: number
          description: Monetary Value of a single item in the given currency
          example: 15.5
        currency:
          type: string
          description: Currency of the given value
          example: EUR
        decimalPlaces:
          type: integer
          description: Number of decimal places for the given currency
          example: 2
        type:
          $ref: '#/components/schemas/ProductValueType'
      required:
        - value
        - currency
      type: object
    ParcelStatus:
      enum:
        - OPEN
        - PROCESSING
        - DONE
        - FAILED
        - CANCELED
        - OBSOLETE
        - WAITING_FOR_INPUT
      type: string
    UserModificationHistory:
      additionalProperties: false
      type: object
      required:
        - modificationDate
        - username
      properties:
        userId:
          description: ID of the user who commited this modification
          type: string
        username:
          description: Username of the user who commited this modification
          type: string
        modificationDate:
          format: date-time
          type: string
    PickJob:
      allOf:
        - $ref: '#/components/schemas/PickJobForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            usersModificationHistory:
              type: array
              items:
                $ref: '#/components/schemas/UserModificationHistory'
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            deliveryinformation:
              $ref: '#/components/schemas/PickjobDeliveryInformation'
            editor:
              $ref: '#/components/schemas/Editor'
            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
            pickLineItems:
              items:
                $ref: '#/components/schemas/PickLineItem'
              type: array
            expectedPickLineItems:
              items:
                $ref: '#/components/schemas/ExpectedPickLineItem'
              type: array
            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'
            pickRunRef:
              type: string
              description: Pick run id to which the pick job belongs
            tags:
              type: array
              minItems: 1
              items:
                $ref: '#/components/schemas/TagReference'
            documentHandling:
              $ref: '#/components/schemas/DocumentHandling'
            resetBlocked:
              type: boolean
              default: false
              description: Indicates if pickJob can still be resetted or restarted
            documentsRef:
              description: Reference to the documents collection from this entity
              type: string
            statusReason:
              type: string
              description: >-
                The reason for the current status. Currently, only reroute
                reasons are supported.
            pickingZones:
              type: array
              items:
                $ref: '#/components/schemas/PickingZone'
          required:
            - id
            - status
            - pickLineItems
            - shortId
            - deliveryinformation
            - documentsRef
          type: object
    PickJobForCreation:
      properties:
        operativeProcessRef:
          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
        deliveryinformation:
          $ref: '#/components/schemas/PickjobDeliveryInformationForCreation'
        facilityRef:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          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
        pickLineItems:
          items:
            $ref: '#/components/schemas/PickLineItemForCreation'
          minItems: 0
          type: array
        expectedPickLineItems:
          items:
            $ref: '#/components/schemas/ExpectedPickLineItemForCreation'
          minItems: 0
          type: array
        paymentInformation:
          $ref: '#/components/schemas/PaymentInformation'
        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: A short identifier that helps assigning a pick job to a customer.
          example: AS12
          type: string
        status:
          $ref: '#/components/schemas/PickJobStatus'
        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:
          description: >-
            Tags can only be set when there is no process related with this
            pickJob. Setting processId and tags will lead to an validationError.
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/TagReference'
        stickers:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/Sticker'
        routingPlanRef:
          description: Reference to the routingplan which created this pickjob
          type: string
        preferredPickingMethods:
          description: Preferred way of picking a given pickJob.
          items:
            $ref: '#/components/schemas/PickingMethodEnum'
          type: array
        transfers:
          type: array
          minItems: 0
          items:
            $ref: '#/components/schemas/OperativeTransfer'
        pickingTimes:
          $ref: '#/components/schemas/PickJobPickingTimes'
      required:
        - orderDate
        - facilityRef
        - pickLineItems
      additionalProperties: false
      type: object
      xml:
        name: Pickjob
    PickingZone:
      description: Zones from which items can be picked
      properties:
        zoneRef:
          type: string
      required:
        - zoneRef
    PaymentInformation:
      properties:
        currency:
          description: The currency in which the consumer paid with
          example: EUR
          type: string
      type: object
    ProductInformation:
      properties:
        productName:
          description: The name of the product used by the carrier
          example: Express
          type: string
        mandatoryShippingAttributes:
          type: array
          items:
            $ref: '#/components/schemas/MandatoryShippingAttribute'
        mandatoryShippingArticleAttributes:
          type: array
          items:
            $ref: '#/components/schemas/MandatoryShippingArticleAttribute'
        mandatoryShippingItemAttributes:
          type: array
          items:
            $ref: '#/components/schemas/MandatoryShippingItemAttribute'
    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
        - WAITING_FOR_INPUT
      type: string
      xml:
        name: PickJobStatusUnprotected
    PickJobStatus:
      description: The status of a pickjob.
      enum:
        - ABORTED
        - OPEN
        - IN_PROGRESS
        - CLOSED
        - PICKED
        - REROUTED
        - REJECTED
        - RESTOWED
        - EXPIRED
        - CANCELED
        - OBSOLETE
        - WAITING_FOR_INPUT
      type: string
      xml:
        name: PickJobStatus
    PickJobLineItemPartialStockLocationForUpdate:
      properties:
        tenantPartialStockId:
          type: string
        picked:
          example: 21
          format: int64
          minimum: 0
          type: number
        stockEmptied:
          example: true
          type: boolean
      required:
        - tenantPartialStockId
        - picked
      type: object
    PickJobLineItemPartialStockLocation:
      allOf:
        - $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForCreation'
      properties:
        picked:
          example: 21
          format: int64
          minimum: 0
          type: number
        stockEmptied:
          example: true
          type: boolean
        zoneRef:
          type: string
        zoneName:
          type: string
      required:
        - tenantPartialStockId
      type: object
    PickJobLineItemPartialStockLocationForCreation:
      properties:
        tenantPartialStockId:
          type: string
        quantity:
          description: >-
            quantity of the specific article that should be picked from given
            stockLocation
          example: 21
          format: int64
          minimum: 0
          type: number
        available:
          example: 21
          format: int64
          minimum: 0
          type: number
        ratingScore:
          type: number
        sequenceScore:
          type: number
        location:
          $ref: '#/components/schemas/Location'
        stockProperties:
          anyOf:
            - $ref: '#/components/schemas/PickingStockPropertyPreset'
            - $ref: '#/components/schemas/PickingStockProperty'
      required:
        - tenantPartialStockId
      type: object
    SubstituteLineItemPartialStockLocation:
      properties:
        quantity:
          example: 21
          format: int64
          minimum: 0
          type: number
        location:
          $ref: '#/components/schemas/Location'
      required:
        - location
        - quantity
      type: object
    PickLineItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ArticleAttributeItem'
              type: array
              maxItems: 40
            prices:
              deprecated: true
              items:
                $ref: '#/components/schemas/ArticlePrice'
              type: array
              description: >-
                <center><img
                src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
                <br /> <i>This endpoint is deprecated and has been
                replaced.</i><br /><br />
          type: object
      xml:
        name: PickLineItemArticle
    ArticlePrice:
      additionalProperties: false
      type: object
      properties:
        pricePerUnit:
          type: number
          example: 9.99
          description: Price value for a given currency per unit
          minimum: 0
        currency:
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          nullable: true
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
      required:
        - pricePerUnit
        - currency
    ReturnedLineItemRefundPrice:
      additionalProperties: false
      properties:
        value:
          example: 20.55
          description: 0.0 till line item price that should be refunded
          type: number
        currency:
          description: The currency of the price as an ISO 4217 code.
          example: EUR
          allOf:
            - $ref: '#/components/schemas/CurrencyCode'
      required:
        - value
        - currency
    PickingPatchActions:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyPickLineItemAction'
              - $ref: '#/components/schemas/ModifyPickJobAction'
              - $ref: '#/components/schemas/ModifyPickJobLastEditorAction'
              - $ref: '#/components/schemas/RestartPickJobAction'
              - $ref: '#/components/schemas/ResetPickJobAction'
              - $ref: '#/components/schemas/AbortPickJobAction'
          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: PickingPatchActions
    PickRunPatchAction:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/ModifyPickRunLineItemAction'
              - $ref: '#/components/schemas/StartPickRunAction'
              - $ref: '#/components/schemas/CancelPickRunAction'
              - $ref: '#/components/schemas/FinishPickRunAction'
          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
    PickRunPickJobsPatchAction:
      properties:
        actions:
          items:
            anyOf:
              - $ref: '#/components/schemas/RemovePickJobFromPickRunAction'
          minItems: 1
          maxItems: 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
    CancelPickRunAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/pickruns/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'CancelPickRun', because you want to cancel a pickrun
              enum:
                - CancelPickRun
              type: string
          required:
            - action
          type: object
      xml:
        name: CancelPickRunAction
    StartPickRunAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/pickruns/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'StartPickRun', because you want to start a pickrun
              enum:
                - StartPickRun
              type: string
          required:
            - action
          type: object
      xml:
        name: StartPickRunAction
    FinishPickRunAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use api/pickruns/:id/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: Use value 'FinishPickRun', because you want to finish a pickrun
              enum:
                - FinishPickRun
              type: string
          required:
            - action
          type: object
      xml:
        name: FinishPickRunAction
    PickJobActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/PickJobAbortActionParameter'
        - $ref: '#/components/schemas/PickJobRestartActionParameter'
        - $ref: '#/components/schemas/PickJobResetActionParameter'
        - $ref: '#/components/schemas/PickJobObsoleteActionParameter'
        - $ref: '#/components/schemas/ModifyPickLineItemsActionParameter'
    PickJobAbortActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickJobAbortActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    PickJobAbortActionEnum:
      enum:
        - ABORT
      type: string
    PickJobRestartActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickJobRestartActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    PickJobRestartActionEnum:
      enum:
        - RESTART
      type: string
    PickJobObsoleteActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickJobObsoleteActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    ModifyPickLineItemsActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ModifyPickJobLineItemsActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        pickJobLineItemUpdates:
          items:
            $ref: '#/components/schemas/PickLineItemUpdate'
          minItems: 1
      required:
        - name
        - version
        - pickJobLineItemUpdates
    PickLineItemUpdate:
      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
        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
        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
        stockEmptied:
          example: true
          type: boolean
        stickers:
          items:
            $ref: '#/components/schemas/Sticker'
            type: array
        partialStockLocations:
          items:
            $ref: '#/components/schemas/PickJobLineItemPartialStockLocationForUpdate'
        scannedCodes:
          description: Scanned Codes of the given picked line item
          items:
            $ref: '#/components/schemas/PickLineItemScannedCode'
          minItems: 0
        status:
          $ref: '#/components/schemas/PickLineItemStatus'
        secondaryPicked:
          type: integer
        substituteLineItems:
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/beta_174x74.png'
              /></center> <br /> <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 disappear also without warning. Thus, it currently does not fall
              under our SLA regulations. For details on this topic please check our
              <a href="https://docs.fulfillmenttools.com/api-docs/connecting-to-fulfillmenttools/restful-api/general-topics/api-release-life-cycle">documentation</a></i><br /><br />
          items:
            $ref: '#/components/schemas/SubstituteLineItemForCreation'
          type: array
        shortPickReason:
          properties:
            reasonLocalized:
              description: Localized reason
              example: '{ en_US: ''SomeName'' }'
              $ref: '#/components/schemas/LocaleString'
      required:
        - id
      type: object
      additionalProperties: false
    ModifyPickJobLineItemsActionEnum:
      enum:
        - MODIFY_PICK_JOB_LINE_ITEMS
      type: string
    PickJobObsoleteActionEnum:
      enum:
        - OBSOLETE
      type: string
    PickJobResetActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickJobResetActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    PickJobResetActionEnum:
      enum:
        - RESET
      type: string
    PackingTargetContainerActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/UpdatePackingTargetContainerLineItemAction'
        - $ref: >-
            #/components/schemas/ReplacePackingTargetContainerLineItemCodesAction
    UpdatePackingTargetContainerLineItemAction:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/UpdatePackingTargetContainerLineItemEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        payload:
          additionalProperties: false
          properties:
            lineItem:
              $ref: '#/components/schemas/PackingTargetContainerLineItem'
          required:
            - lineItem
      required:
        - version
        - payload
        - name
    UpdatePackingTargetContainerLineItemEnum:
      enum:
        - UpdateLineItem
      type: string
    ReplacePackingTargetContainerLineItemCodesEnum:
      enum:
        - ReplaceLineItemCodes
      type: string
    ReplacePackingTargetContainerLineItemCodesAction:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ReplacePackingTargetContainerLineItemCodesEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        payload:
          additionalProperties: false
          properties:
            codes:
              items:
                description: List of codes
                type: string
                minItems: 1
              type: array
          required:
            - codes
      required:
        - payload
        - version
        - name
    PickRunActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/PickRunStartActionParameter'
        - $ref: '#/components/schemas/PickRunFinishActionParameter'
        - $ref: '#/components/schemas/PickRunCancelActionParameter'
        - $ref: '#/components/schemas/PickRunRemovePickJobActionParameter'
    PickRunFinishActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickRunFinishActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    PickRunFinishActionEnum:
      enum:
        - FINISH
      type: string
    PickRunStartActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickRunStartActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    PickRunStartActionEnum:
      enum:
        - START
      type: string
    PickRunRemovePickJobActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickRunRemovePickJobActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        payload:
          additionalProperties: false
          properties:
            pickJobId:
              type: string
              example: 4baaa052-7286-4dc2-937f-6e703ece25ac
          required:
            - pickJobId
      required:
        - name
        - version
        - payload
    PickRunRemovePickJobActionEnum:
      enum:
        - REMOVE_PICK_JOB
      type: string
    PickRunCancelActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/PickRunCancelActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
      required:
        - name
        - version
    PickRunCancelActionEnum:
      enum:
        - CANCEL
      type: string
    HandoverJobActionsParameter:
      anyOf:
        - $ref: '#/components/schemas/HandoverJobCancelActionParameter'
        - $ref: '#/components/schemas/HandoverJobLineItemUpdateActionParameter'
        - $ref: '#/components/schemas/FinishHandoverJobActionParameter'
    HandoverJobCancelActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/HandoverJobCancelActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        payload:
          additionalProperties: false
          properties:
            handoverJobCancelReason:
              $ref: '#/components/schemas/HandoverJobCancelReason'
          required:
            - handoverJobCancelReason
      required:
        - name
        - version
        - payload
    HandoverJobLineItemUpdateActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/HandoverJobLineItemUpdateActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        lineItem:
          additionalProperties: false
          properties:
            id:
              type: string
            refused:
              items:
                $ref: '#/components/schemas/RefusedItemForUpdate'
            substituteItems:
              type: array
              items:
                $ref: '#/components/schemas/HandoverSubstituteLineItemForUpdate'
          required:
            - id
      required:
        - name
        - version
        - lineItem
    FinishHandoverJobActionParameter:
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/FinishHandoverJobActionEnum'
        version:
          description: Version of the entity to be changed
          minimum: 0
          type: integer
        lineItems:
          additionalProperties: false
          type: array
          items:
            $ref: '#/components/schemas/FinishHandoverJobLineItem'
      required:
        - name
        - version
        - lineItems
    RefusedItem:
      properties:
        quantity:
          type: integer
          minimum: 0
        reason:
          type: string
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        comment:
          type: string
      required:
        - quantity
    RefusedItemForUpdate:
      properties:
        quantity:
          type: integer
          minimum: 0
        reasonLocalized:
          $ref: '#/components/schemas/LocaleString'
        comment:
          type: string
      required:
        - quantity
    HandoverSubstituteLineItemForUpdate:
      properties:
        id:
          type: string
        refused:
          type: array
          items:
            $ref: '#/components/schemas/RefusedItemForUpdate'
      required:
        - id
    FinishHandoverJobLineItem:
      additionalProperties: false
      properties:
        id:
          type: string
        handedOverQuantity:
          type: number
        refused:
          type: array
          items:
            $ref: '#/components/schemas/RefusedItemForUpdate'
        substituteLineItems:
          type: array
          items:
            $ref: '#/components/schemas/FinishHandoverJobSubstituteLineItem'
      required:
        - id
        - handedOverQuantity
    FinishHandoverJobSubstituteLineItem:
      properties:
        id:
          type: string
        handedOverQuantity:
          minimum: 0
          type: integer
        refused:
          type: array
          items:
            $ref: '#/components/schemas/RefusedItemForUpdate'
      required:
        - id
        - handedOverQuantity
    HandoverJobCancelActionEnum:
      enum:
        - CANCEL
      type: string
    HandoverJobLineItemUpdateActionEnum:
      enum:
        - UPDATE_LINEITEM
      type: string
    FinishHandoverJobActionEnum:
      enum:
        - FINISH_HANDOVER_JOB
      type: string
    ModifyPickRunLineItemAction:
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - 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
            picked:
              description: The amount of articles that were picked for this pickline.
              example: 20
              format: int64
              minimum: 0
              type: integer
            status:
              $ref: '#/components/schemas/PickLineItemStatus'
            partialStockLocations:
              items:
                $ref: >-
                  #/components/schemas/PickJobLineItemPartialStockLocationForUpdate
          required:
            - id
            - action
          type: object
      xml:
        name: ModifyPickRunLineItemAction
    RemovePickJobFromPickRunAction:
      deprecated: true
      description: >-
        <center><img
        src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
        <br /> <i>This endpoint is deprecated and has been replaced.</i><br
        /><br />@deprecated Use /api/pickruns/{pickRunId}/actions instead
      allOf:
        - $ref: '#/components/schemas/AbstractModificationAction'
        - additionalProperties: false
          properties:
            action:
              description: >-
                Use value 'RemovePickJobFromPickRunAction', because you want to
                remove a pickjob
              enum:
                - RemovePickJobFromPickRunAction
              type: string
            pickJobRef:
              description: PickJob reference of the PickJob you want to remove.
              type: string
          required:
            - action
            - pickJobRef
          type: object
      xml:
        name: RemovePickJobFromPickRunAction
    PickingTimes:
      description: 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
    PickjobDeliveryInformation:
      allOf:
        - $ref: '#/components/schemas/PickjobDeliveryInformationForCreation'
        - required:
            - targetTime
            - channel
    PickjobDeliveryInformationForCreation:
      properties:
        channel:
          enum:
            - COLLECT
            - SHIPPING
          type: string
        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
                carrierProductCategory:
                  $ref: '#/components/schemas/CarrierProductCategory'
                carrierProduct:
                  description: >-
                    Desired product of given carrier to choose when ordering a
                    label, this is specific to a carrier
                  type: string
                  example: EXPRESS
                carrierServices:
                  type: array
                  items:
                    $ref: '#/components/schemas/CarrierServices'
                identifier:
                  description: >-
                    Includes information on how to identify Ship from Store
                    recipient (Name, PIN, Reference number, ...)
                  type: string
                recipientaddress:
                  $ref: '#/components/schemas/ConsumerAddress'
                invoiceAddress:
                  $ref: '#/components/schemas/ConsumerAddress'
                postalAddress:
                  $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
    PreselectedFacility:
      properties:
        facilityRef:
          description: Reference to the facility which is supposed to fulfill the order
          type: string
      required:
        - facilityRef
      type: object
    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
    PrioritizationRuleImplementation:
      enum:
        - CUSTOM
      type: string
      xml:
        name: PrioritizationRuleImplementation
    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
    DomainStatusHistoryItem:
      description: >-
        This item represent a process status change triggered by a specific
        domain.
      properties:
        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
        domain:
          description: The domain of the entity that caused the status change.
          $ref: '#/components/schemas/DomainType'
        domainRef:
          description: The id of the domain entity that caused the status change.
          type: string
        domainEntityProcessStatus:
          description: The assigned status
          $ref: '#/components/schemas/DomainStatus'
        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
      required:
        - timestamp
        - domain
        - domainEntityProcessStatus
        - domainRef
      type: object
    LastDomainEntityStatusItem:
      description: >-
        An object holding the last DomainStatus of a given entity and its
        corresponding domain.
      properties:
        domain:
          description: The domain of the entity that caused the status change.
          $ref: '#/components/schemas/DomainType'
        status:
          description: The status of the entity.
          $ref: '#/components/schemas/DomainStatus'
        entityId:
          description: The entity id
          type: string
      required:
        - domain
        - status
        - entityId
      type: object
    Process:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        tags:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/TagReference'
        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
        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
        handoverJobRefs:
          description: References to Handoverjobs connected to this process (if present).
          items:
            type: string
          type: array
        id:
          description: ID of this process
          type: string
        isAnonymized:
          description: Indicates if the entities have been anonymized.
          type: boolean
        orderRef:
          description: References to the Order connected to this process (if present).
          type: string
        routingPlanRefs:
          description: >-
            References the RoutingPlans that were used during 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:
          description: References to the Returns connected to this process (if present).
          items:
            type: string
          type: array
        itemReturnJobsRef:
          description: >-
            References to the Item Return Job 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
        tenantOrderId:
          description: The tenantOrderId referencing this process.
          type: string
        documentRefs:
          description: References to documents that are attached to this process.
          items:
            type: string
          type: array
        status:
          description: Overall status of the process.
          $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
        domsStatus:
          description: Overall DOMS status of the process.
          $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
        operativeStatus:
          description: Overall operative status of the process
          $ref: '#/components/schemas/ProcessStatus'
          default: CREATED
        returnStatus:
          description: Overall return status of the process
          $ref: '#/components/schemas/ProcessStatus'
          default: NOT_AVAILABLE
        domainStatuses:
          type: object
          description: Overview of the different domain adherent status of the process.
          additionalProperties:
            $ref: '#/components/schemas/DomainStatus'
        lastDomainEntityStatuses:
          type: array
          description: The last domain statuses of each domain
          items:
            $ref: '#/components/schemas/LastDomainEntityStatusItem'
        packJobRefs:
          description: References of the Packjobs connected to this process (if present).
          items:
            type: string
          type: array
        facilityRefs:
          description: References of the Facilities connected to this process (if any).
          items:
            type: string
          type: array
        domainStatusHistory:
          description: >-
            History of process status changes caused by changes on the related
            domains.
          type: array
          items:
            $ref: '#/components/schemas/DomainStatusHistoryItem'
        serviceJobRefs:
          description: >-
            References to the Service Jobs connected to this process (if
            present).
          items:
            type: string
          type: array
        externalActionRefs:
          description: >-
            References to the external actions connected to this process (if
            any).
          items:
            type: string
          type: array
      required:
        - gdprCleanupDate
        - id
      type: object
    ProcessProgressLog:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        processRef:
          type: string
        domainEntityProcessStatus:
          $ref: '#/components/schemas/DomainStatus'
        domain:
          $ref: '#/components/schemas/DomainType'
        domainRef:
          type: string
        domainStatus:
          type: string
        domainLastModified:
          description: The last modified date of the related domain entity
          example: '2020-02-03T09:45:51.525Z'
          format: date-time
          type: string
        domainVersion:
          description: The version of the related domain entity
          example: 1
          format: int64
          type: integer
        attributes:
          type: object
        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
      required:
        - id
        - domainVersion
        - processRef
        - domainEntityProcessStatus
        - domain
        - domainRef
        - domainStatus
    DomainStatus:
      enum:
        - PENDING
        - CREATED
        - IN_PROGRESS
        - STUCK
        - FINISHED
        - CANCELED
        - OBSOLETE
      type: string
    ProcessStatus:
      enum:
        - CREATED
        - IN_PROGRESS
        - FINISHED
        - CANCELED
        - ERROR
        - NOT_AVAILABLE
      type: string
    DomainType:
      enum:
        - ORDER
        - ROUTING_PLAN
        - PICKJOB
        - PACKJOB
        - SHIPMENT
        - HANDOVER
        - RETURN
        - SERVICE_JOB
        - ITEM_RETURN_JOB
      type: string
    Section:
      enum:
        - ORDER
        - PACKJOB
        - PICKJOB
        - HANDOVERJOB
        - PARCEL
        - PACKING_TARGET_CONTAINER
      type: string
    DocumentType:
      enum:
        - PDF
        - PNG
        - JPG
        - GIF
        - JPEG
      type: string
    ExternalDocument:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        type:
          $ref: '#/components/schemas/DocumentType'
        section:
          $ref: '#/components/schemas/Section'
        name:
          type: string
        path:
          type: string
        id:
          type: string
        priority:
          type: number
          minimum: 0
      required:
        - type
        - section
        - id
      type: object
    ExternalDocumentInSectionForCreation:
      additionalProperties: false
      properties:
        type:
          $ref: '#/components/schemas/DocumentType'
        file:
          $ref: '#/components/schemas/NamedFile'
        priority:
          type: number
          minimum: 0
      required:
        - type
      type: object
    ExternalDocumentForCreation:
      additionalProperties: false
      properties:
        type:
          $ref: '#/components/schemas/DocumentType'
        section:
          $ref: '#/components/schemas/Section'
        file:
          $ref: '#/components/schemas/NamedFile'
        priority:
          type: number
          minimum: 0
      required:
        - type
        - section
      type: object
    ExternalDocumentForUpdate:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        file:
          $ref: '#/components/schemas/NamedFile'
      required:
        - file
      type: object
    OidcProviders:
      properties:
        providers:
          items:
            $ref: '#/components/schemas/StrippedOidcProvider'
          type: array
        total:
          type: number
      required:
        - providers
        - total
    OidcProviderForUpdate:
      allOf:
        - $ref: '#/components/schemas/OidcProviderForCreation'
      properties:
        version:
          description: >-
            The version of the document to be used in optimistic locking
            mechanisms.
          example: 42
          format: int64
          type: integer
      required:
        - version
    OidcProviderForCreation:
      properties:
        name:
          type: string
          minLength: 3
          maxLength: 15
        status:
          $ref: '#/components/schemas/OidcProviderStatus'
        issuer:
          type: string
        clientId:
          type: string
        customParameters:
          type: array
          items:
            $ref: '#/components/schemas/OidcProviderCustomParameter'
          minItems: 0
          maxItems: 3
        clientSecret:
          type: string
        assignedGroups:
          type: array
          items:
            $ref: '#/components/schemas/AssignedGroup'
      required:
        - clientSecret
        - name
        - status
        - issuer
        - clientId
        - customParameters
        - assignedGroups
    OidcProviderCustomParameter:
      type: object
      properties:
        key:
          type: string
        value:
          type: string
      required:
        - key
        - value
    StrippedOidcProvider:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          type: string
        name:
          type: string
          minLength: 3
          maxLength: 15
        status:
          $ref: '#/components/schemas/OidcProviderStatus'
        issuer:
          type: string
        clientId:
          type: string
        customParameters:
          items:
            $ref: '#/components/schemas/OidcProviderCustomParameter'
          minItems: 0
          maxItems: 3
          type: array
        assignedGroups:
          type: array
          items:
            $ref: '#/components/schemas/AssignedGroup'
      required:
        - id
        - name
        - status
        - issuer
        - clientId
        - customParameters
        - assignedGroups
    OidcProviderStatus:
      description: Status of Provider
      enum:
        - ACTIVE
        - INACTIVE
      type: string
    AssignedGroup:
      type: object
      properties:
        group:
          type: string
          minLength: 1
        facilityRefs:
          type: array
          minItems: 1
          items:
            type: string
      required:
        - group
        - facilityRefs
    RerouteShortPickConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        blacklistAssignedFacilities:
          default: false
          description: >-
            Does not consider facilities which previously owned the pickjob
            during routing.
          type: boolean
        clickAndCollectReroute:
          $ref: '#/components/schemas/ClickAndCollectRerouteConfiguration'
        restowAfterMinutes:
          description: The amount of minutes after which an automated restow is executed
          example: '60'
          type: number
        shipFromStoreReroute:
          $ref: '#/components/schemas/ShipFromStoreRerouteConfiguration'
        id:
          type: string
        rerouteZeroPicksOnly:
          default: false
          description: Whether or not only pickjobs with zero items picked may be rerouted
          type: boolean
      required:
        - clickAndCollectReroute
        - shipFromStoreReroute
      type: object
    ClickAndCollectRerouteConfiguration:
      properties:
        active:
          type: boolean
        rerouteType:
          $ref: '#/components/schemas/RerouteType'
      required:
        - active
      type: object
    ShipFromStoreRerouteConfiguration:
      properties:
        active:
          type: boolean
        allowManualReroute:
          default: false
          description: >-
            @deprecated This config property is deprecated since 26/02/24. Use
            GlobalManualRerouteConfiguration instead.
          type: boolean
          deprecated: true
        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
    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
    ReturnArticleAttributeItem:
      allOf:
        - $ref: '#/components/schemas/ArticleAttributeItem'
    ReturnConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        active:
          deprecated: true
          default: true
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
            <br /> <i>This endpoint is deprecated and has been replaced.</i><br
            /><br />Enable or disable legacy returns. Use
            returnTypeConfiguration instead
          type: boolean
        returnTypeConfiguration:
          $ref: '#/components/schemas/ReturnTypeConfiguration'
        availableItemConditions:
          items:
            $ref: '#/components/schemas/AvailableItemCondition'
        availableReturnReasons:
          items:
            $ref: '#/components/schemas/AvailableReturnReason'
      required:
        - active
      type: object
    ExpiryConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        provisioningTimeOffsetInMinutes:
          type: integer
          minimum: 0
      required:
        - provisioningTimeOffsetInMinutes
      type: object
    AvailableItemCondition:
      additionalProperties: false
      properties:
        conditionLocalized:
          description: Will be translated into 'condition' when requested
          $ref: '#/components/schemas/LocaleString'
          example:
            de_DE: Beschädigt
            en_US: Damaged
    AvailableReturnReason:
      additionalProperties: false
      properties:
        reasonLocalized:
          description: Will be translated into 'reason' when requested
          example:
            de_DE: Beschädigt
            en_US: Damaged
          $ref: '#/components/schemas/LocaleString'
      required:
        - reasonLocalized
    LocalizedReturnConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        active:
          deprecated: true
          default: true
          description: >-
            <center><img
            src='https://storage.googleapis.com/ocff-assets/api/fft-deprectated_254x51.png'></center>
            <br /> <i>This endpoint is deprecated and has been replaced.</i><br
            /><br />Enable or disable legacy returns. Use
            returnTypeConfiguration instead
          type: boolean
        returnTypeConfiguration:
          $ref: '#/components/schemas/ReturnTypeConfiguration'
        availableItemConditions:
          items:
            $ref: '#/components/schemas/LocalizedAvailableItemCondition'
        availableReturnReasons:
          items:
            $ref: '#/components/schemas/LocalizedAvailableReturnReason'
      required:
        - active
      type: object
    LocalizedAvailableItemCondition:
      additionalProperties: false
      properties:
        condition:
          type: string
          example: Damaged
          description: translated conditionsLocalized
        conditionLocalized:
          $ref: '#/components/schemas/LocaleString'
          example:
            de_DE: Beschädigt
            en_US: Damaged
      required:
        - conditionLocalized
        - condition
    LocalizedAvailableReturnReason:
      allOf:
        - $ref: '#/components/schemas/AvailableReturnReason'
      additionalProperties: false
      properties:
        reason:
          type: string
          example: Damaged
          description: translated reasonLocalized
      required:
        - reasonLocalized
        - reason
    ReturnTypeConfiguration:
      properties:
        type:
          $ref: '#/components/schemas/ReturnConfigurationType'
      required:
        - type
    ReturnConfigurationType:
      type: string
      enum:
        - RETURN
        - ITEM_RETURN
    ReturnItemArticle:
      allOf:
        - $ref: '#/components/schemas/AbstractArticle'
        - properties:
            attributes:
              items:
                $ref: '#/components/schemas/ReturnArticleAttributeItem'
              type: array
              maxItems: 40
          type: object
      xml:
        name: ReturnItemArticle
    ReturnJob:
      allOf:
        - $ref: '#/components/schemas/ReturnJobForCreation'
        - $ref: '#/components/schemas/VersionedResource'
        - properties:
            facilityRef:
              description: >-
                Reference to the facility which could have been given via
                tenantFacilityID while creating
              type: string
            anonymized:
              description: Indicates if gdpr related data was anonymized
              example: false
              type: boolean
            id:
              description: >-
                The id of this returnJob. It is generated during creation
                automatically and suits as the primary identifier of the
                described entity.
              example: Esb20gpHBL94X5NdMp3C
              minItems: 1
              type: string
          required:
            - id
          type: object
      xml:
        name: ReturnJob
    ReturnJobForCreation:
      additionalProperties: false
      properties:
        carrierTrackingNumber:
          example: '84168117830018'
          type: string
        consumerAddress:
          $ref: '#/components/schemas/ConsumerAddress'
        facilityAddress:
          $ref: '#/components/schemas/FacilityAddress'
        tenantFacilityId:
          description: >-
            The id of the facility reference. The given ID has to be present in
            the system.
          example: Esb20gpHBL94X5NdMp3C
          type: string
        orderRef:
          description: The id of the order
          example: LGMl2DuvPnfPoSHhYFOm
          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
        returnLines:
          items:
            $ref: '#/components/schemas/ReturnLine'
          minItems: 1
          type: array
        status:
          $ref: '#/components/schemas/ReturnStatus'
        tenantOrderId:
          type: string
        customAttributes:
          description: >-
            Attributes that can be added to the return job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
      required:
        - returnLines
      type: object
    ReturnJobs:
      properties:
        returnJobs:
          items:
            $ref: '#/components/schemas/ReturnJob'
          type: array
        total:
          description: Total number of found entities for this query
          example: 42
          type: integer
      required:
        - returnJobs
        - total
    ReturnLine:
      properties:
        article:
          $ref: '#/components/schemas/ReturnItemArticle'
        delivered:
          description: The amount of articles that were delivered
          example: 20
          format: int64
          minimum: 0
          type: integer
        id:
          description: >-
            The id of this return Item. It is generated during creation
            automatically and suits as the primary identifier of the described
            entity.
          example: climk4dcQFiPdA5ULuhS
          type: string
        pickJobRefs:
          items:
            description: List of corresponding pickjob Ids
            type: string
          minItems: 1
          type: array
        returned:
          $ref: '#/components/schemas/Returned'
        scannableCodes:
          items:
            description: Codes, that identify the article
            type: string
          type: array
        status:
          $ref: '#/components/schemas/ReturnLineStatus'
        customAttributes:
          description: >-
            Attributes that can be added to the return job. These attributes
            cannot be used within fulfillment processes, but it could be useful
            to have the information carried here.
      required:
        - pickJobRefs
        - id
        - status
        - delivered
        - returned
        - scannableCodes
        - article
      type: object
    ShortPickReason:
      additionalProperties: false
      properties:
        reason:
          description: translated reasonLocalized according to the given locale
          type: string
        active:
          type: boolean
          example: true
          description: Flag to mark a reason as active or inactive
        reasonLocalized:
          description: Localized reason
          example: '{ en_US: ''SomeName'' }'
          $ref: '#/components/schemas/LocaleString'
      required:
        - active
        - reasonLocalized
    ReturnLineStatus:
      description: A return item line initially has the status INITIAL.
      enum:
        - INITIAL
        - ADVISED
        - ACCEPTED
        - DECLINED
        - CANCELED
      type: string
      xml:
        name: ReturnItemStatus
    ReturnNoteConfiguration:
      allOf:
        - $ref: '#/components/schemas/VersionedResource'
      properties:
        id:
          example: delivery-note
          type: string
        logoUrl:
          type: string
        pdfBackgroundConfiguration:
          $ref: '#/components/schemas/PdfBackgroundConfiguration'
        companyAddress:
          $ref: '#/components/schemas/CompanyAddress'
        orderDateLabel:
          $ref: '#/components/schemas/LocaleString'
        orderNumberLabel:
          $ref: '#/components/schemas/LocaleString'
        headline:
          $ref: '#/components/schemas/LocaleString'
        quantityLabel:
          $ref: '#/components/schemas/LocaleString'
        articleIdLabel:
          $ref: '#/components/schemas/LocaleString'
        articleTitleLabel:
          $ref: '#/components/schemas/LocaleString'
        returnReasonLabel:
          $ref: '#/components/schemas/LocaleString'
        returnReasonExplanationHeadline:
          $ref: '#/components/schemas/LocaleString'
        returnReasonExplanation:
          $ref: '#/components/schemas/LocaleString'
        reasons:
          deprecated: true
          description: Deprecated - use ReturnConfiguration.availableReturnReasons instead
          items:
            $ref: '#/components/schemas/LocaleString'
          type: array
        disclaimerHeadline:
          $ref: '#/components/schemas/LocaleString'
        disclaimer:
          $ref: '#/components/schemas/LocaleString'
        displayPageLabel:
          type: boolean
          default: false
          description: Determines if the page label should be shown
        pageLabel:
          $ref: '#/components/schemas/LocaleString'
        substituteText:
          $ref: '#/components/schemas/LocaleString'
      required:
        - id
        - orderDateLabel
        - orderNumberLabel
        - headline
        - quantityLabel
        - articleIdLabel