AEB Carrier Setup API

openapi: 3.2.0
info:
  title: Carrier Connect HTTP Carrier Setup API
  description: Thank you for using our HTTP API documentation.
  version: '3.0'
servers:
- url: https://rz3.aeb.de/demo1cai/rest
security:
- SWAGGER_AUTH_KEY: []
- BASIC_AUTH: []
tags:
- name: CarrierSetup
  description: Rest API for carrier setups
paths:
  /carrier-setups/{id}:
    get:
      tags:
      - CarrierSetup
      description: Returns a carrier setup with the requested ID.
      operationId: getCarrierSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierSetup'
              examples:
                Carrier setup entry:
                  description: Carrier setup entry
                  value:
                    identCode: UPS
                    isEnabled: true
                    name: UPS EMEA
                    type: STANDARD
        '404':
          description: Requested carrier setup does not exist.
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
    put:
      tags:
      - CarrierSetup
      description: Create or update a carrier setup with the requested ID. If the carrier setup with the given ID does not exist, a new carrier setup will be created. If the carrier setup exists, the existing carrier setup is fully updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an existing carrier setup. It is therefore recommended to use the GET/carrier-setups to check whether a carrier setup with an ID already exists BEFORE you use PUT/carrier-setup/{id}.
      operationId: createOrUpdateCarrierSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarrierSetup'
            examples:
              Carrier setup request:
                description: Carrier setup request
                value:
                  identCode: UPS
                  isEnabled: true
                  name: UPS EMEA
                  type: STANDARD
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierSetup'
              examples:
                Carrier setup entry:
                  description: Carrier setup entry
                  value:
                    identCode: UPS
                    isEnabled: true
                    name: UPS EMEA
                    type: STANDARD
        '409':
          description: Locking error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AebProblem'
              examples:
                Carrier setup is locked:
                  description: Carrier setup is locked
                  value:
                    type: about:blank
                    status: 409
                    title: Locked
                    detail: Locking für Dienstleister-Einrichtung - [UPS EMEA] fehlgeschlagen.
                    timestamp: '2024-09-26T11:33:35.095908100Z'
                    errors: []
        '404':
          description: Requested carrier definition does not exist.
          content:
            application/json:
              examples:
                Carrier definition not found:
                  description: Carrier definition not found
                  value:
                    errorMessage: Keine Dienstleister-Definition mit der ID 'BASS' gefunden.
    delete:
      tags:
      - CarrierSetup
      description: Delete a carrier setup with the requested ID.
      operationId: deleteCarrierSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierSetup'
              examples:
                Carrier setup entry:
                  description: Carrier setup entry
                  value:
                    identCode: UPS
                    isEnabled: true
                    name: UPS EMEA
                    type: STANDARD
        '409':
          description: Locking error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AebProblem'
              examples:
                Carrier setup is locked:
                  description: Carrier setup is locked
                  value:
                    type: about:blank
                    status: 409
                    title: Locked
                    detail: Locking für Dienstleister-Einrichtung - [UPS EMEA] fehlgeschlagen.
                    timestamp: '2024-09-26T11:33:35.095908100Z'
                    errors: []
        '404':
          description: Requested carrier setup does not exist.
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
  /carrier-setups:
    get:
      tags:
      - CarrierSetup
      description: Returns all carrier setups matching the given filter criteria. In case no carrier setup matches the given filter criteria an empty collection is returned. If the filter field supports place holders ('*' or '%'), you get all carrier setups back beginning with the value of the filter which means a place holder at the end of the filter value is added automatically.
      operationId: searchCarrierSetups
      parameters:
      - name: ident_code_like
        in: query
        description: Filter carrier setups by ident code.<br>In the example, all carrier setups which includes 'DHL' are returned.<br>This filter field is case insensitive.<br>Place holders are supported. The ident code is unique.
        schema:
          maxLength: 20
          minLength: 0
          type: string
        example: '*DHL*'
      - name: offset
        in: query
        description: 'The starting point from which to return elements of the ordered list.<br><i>Minimum : 0</i>'
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 0
      - name: limit
        in: query
        description: 'The maximum number of elements to be returned from the ordered list.<br><i>Minimum : 1</i><br><i>Maximum : 1000</i>'
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int32
          default: 1000
        example: 200
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierSetupPage'
              examples:
                Carrier setup list:
                  description: Carrier setup list
                  value:
                    content:
                    - identCode: UPS
                      isEnabled: false
                      name: UPS EMEA
                      type: STANDARD
                    - identCode: DHLPAKETINT
                      isEnabled: false
                      name: DHL Paket international
                      type: STANDARD
  /carrier-setups/{id}/additional-values/{additional-value-id}:
    get:
      tags:
      - CarrierSetup
      description: Returns an additional value setup of a carrier setup with the requested ID.
      operationId: getAdditionalValueSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      - name: additional-value-id
        in: path
        description: The requested ID of an additional value setup.
        required: true
        schema:
          type: string
        example: UPSPREMIER
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdditionalValuesSetup'
              examples:
                Additional value setup entry:
                  description: Additional value setup entry
                  value:
                    identCode: TEST12
                    type: SETUP_SPECIFIC
                    attributes:
                      dataType: STRING
                      businessObject: SHIPMENT
                      translations:
                      - language: DE
                        name: testD
                      - language: EN
                        name: testE
                      choiceList:
                      - identCode: kürzel
                        ediCode: Edi
                        translations:
                        - language: EN
                        - language: DE
                          name: testD
        '404':
          description: Requested additional value setup does not exist.
          content:
            application/json:
              examples:
                Additional value setup not found:
                  description: Additional value setup not found
                  value:
                    errorMessage: Keine Zusatzfeld-Einrichtung mit der ID 'UPSOTHERCHA' für die Dienstleister-Einrichtung 'UPS' gefunden.
    put:
      tags:
      - CarrierSetup
      description: Create or update an additional value setup of a carrier setup with the requested ID. If the additional value setup with the given ID does not exist, a new additional value setup will be created. If the additional value setup exists, the existing additional value setup is fully updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an existing additional value setup. It is therefore recommended to use the GET/carrier-setups/{id}/additional-values to check whether an additional value setup with an ID already exists BEFORE you use PUT/carrier-setups/{id}/additional-values/{id}
      operationId: createOrUpdateAdditionalValueSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      - name: additional-value-id
        in: path
        description: The requested ID of an additional value setup.
        required: true
        schema:
          type: string
        example: UPSPREMIER
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdditionalValuesSetup'
            examples:
              Additional value setup request:
                description: Additional value setup request
                value:
                  identCode: TEST12
                  type: SETUP_SPECIFIC
                  attributes:
                    dataType: STRING
                    businessObject: SHIPMENT
                    translations:
                    - language: DE
                      name: testD
                    - language: EN
                      name: testE
                    choiceList:
                    - identCode: kürzel
                      ediCode: Edi
                      translations:
                      - language: EN
                      - language: DE
                        name: testD
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdditionalValuesSetup'
              examples:
                Additional value setup entry:
                  description: Additional value setup entry
                  value:
                    identCode: TEST12
                    type: SETUP_SPECIFIC
                    attributes:
                      dataType: STRING
                      businessObject: SHIPMENT
                      translations:
                      - language: DE
                        name: testD
                      - language: EN
                        name: testE
                      choiceList:
                      - identCode: kürzel
                        ediCode: Edi
                        translations:
                        - language: EN
                        - language: DE
                          name: testD
        '400':
          description: Wrong additional value type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AebProblem'
              examples:
                Wrong additional value type in the request.:
                  description: Wrong additional value type in the request.
                  value:
                    type: additional-value/wrong-type
                    status: 400
                    title: Wrong AdditionalValueType
                    detail: Die angegebene Zusatzfeldart entspricht nicht der vorhandenen Zusatzfeldart.
                    timestamp: '2024-09-26T11:57:01.261294600Z'
                    errors: []
        '404':
          description: Requested additional value definition does not exist.
          content:
            application/json:
              examples:
                Additional value definition not found:
                  description: Additional value definition not found
                  value:
                    errorMessage: Keine Zusatzfeld-Definition mit der ID 'UPSOTHERCHA' für die Dienstleister-Definition 'UPS' gefunden.
        '500':
          description: Additional value already exists.
          content:
            application/json:
              examples:
                Requested additional value with the same id already exists.:
                  description: Requested additional value with the same id already exists.
                  value:
                    errorMessage: 'Commit der Transaktion ist fehlgeschlagen: Cannot commit changes: Zusatzfeld - [testD]: Es existiert bereits ein Eintrag für Zusatzfeld mit Dienstleister-Einrichtung ''UPS EMEA'' und Kürzel ''TEST12''.'
                    errorCause: 'Cannot commit changes: Zusatzfeld - [testD]: Es existiert bereits ein Eintrag für Zusatzfeld mit Dienstleister-Einrichtung ''UPS EMEA'' und Kürzel ''TEST12''.'
    delete:
      tags:
      - CarrierSetup
      description: Deletes an additional value setup of a carrier setup with the requested ID.
      operationId: deleteAdditionalValueSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      - name: additional-value-id
        in: path
        description: The requested ID of an additional value setup.
        required: true
        schema:
          type: string
        example: UPSPREMIER
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdditionalValuesSetup'
              examples:
                Additional value setup entry:
                  description: Additional value setup entry
                  value:
                    identCode: TEST12
                    type: SETUP_SPECIFIC
                    attributes:
                      dataType: STRING
                      businessObject: SHIPMENT
                      translations:
                      - language: DE
                        name: testD
                      - language: EN
                        name: testE
                      choiceList:
                      - identCode: kürzel
                        ediCode: Edi
                        translations:
                        - language: EN
                        - language: DE
                          name: testD
        '404':
          description: Requested additional value setup does not exist.
          content:
            application/json:
              examples:
                Additional value setup not found:
                  description: Additional value setup not found
                  value:
                    errorMessage: Keine Zusatzfeld-Einrichtung mit der ID 'UPSOTHERCHA' für die Dienstleister-Einrichtung 'UPS' gefunden.
  /carrier-setups/{id}/additional-values:
    get:
      tags:
      - CarrierSetup
      description: Returns all additional value setups of a carrier setup.
      operationId: getAdditionalValueSetups
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdditionalValueSetupPage'
              examples:
                Additional value setup list:
                  description: Additional value setup list
                  value:
                    content:
                    - identCode: Additional Value
                      type: SETUP_SPECIFIC
                      attributes:
                        dataType: CHOICE
                        businessObject: SHIPMENT
                        translations:
                        - language: DE
                          name: testD
                        - language: EN
                          name: testE
                        choiceList:
                        - identCode: kürzel
                          ediCode: Edi
                          translations:
                          - language: EN
                          - language: DE
                            name: testD
                    - identCode: UPSMRN
                      type: DEFINITION_BASED
                      attributes:
                        dataType: STRING
                        businessObject: SHIPMENT
                        translations:
                        - name: MRN
                        - name: MRN
        '404':
          description: Requested carrier setup does not exist.
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
    put:
      tags:
      - CarrierSetup
      description: Create or update all additional value setups of a carrier setup with the requested ID. If the additional value setup with the given ID does not exist, a new additional value setup will be created. If the additional value setup exists, the existing additional value setup is fully updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an existing additional value setup. It is therefore recommended to use the GET/carrier-setups/{id}/additional-values to check whether an additional value setup with an ID already exists BEFORE you use PUT/carrier-setups/{id}/additional-values.
      operationId: createOrUpdateAllAdditionalValueSetups
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdditionalValueSetupPage'
            examples:
              Additional value setup list request:
                description: Additional value setup list request
                value:
                  content:
                  - identCode: Additional Value
                    type: SETUP_SPECIFIC
                    attributes:
                      dataType: CHOICE
                      businessObject: SHIPMENT
                      translations:
                      - language: DE
                        name: testD
                      - language: EN
                        name: testE
                      choiceList:
                      - identCode: kürzel
                        ediCode: Edi
                        translations:
                        - language: EN
                        - language: DE
                          name: testD
                  - identCode: UPSMRN
                    type: DEFINITION_BASED
                    attributes:
                      dataType: STRING
                      businessObject: SHIPMENT
                      translations:
                      - name: MRN
                      - name: MRN
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdditionalValueSetupPage'
              examples:
                Additional value setup list:
                  description: Additional value setup list
                  value:
                    content:
                    - identCode: Additional Value
                      type: SETUP_SPECIFIC
                      attributes:
                        dataType: CHOICE
                        businessObject: SHIPMENT
                        translations:
                        - language: DE
                          name: testD
                        - language: EN
                          name: testE
                        choiceList:
                        - identCode: kürzel
                          ediCode: Edi
                          translations:
                          - language: EN
                          - language: DE
                            name: testD
                    - identCode: UPSMRN
                      type: DEFINITION_BASED
                      attributes:
                        dataType: STRING
                        businessObject: SHIPMENT
                        translations:
                        - name: MRN
                        - name: MRN
        '400':
          description: Wrong additional value type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AebProblem'
              examples:
                Wrong additional value type in the request.:
                  description: Wrong additional value type in the request.
                  value:
                    type: additional-value/wrong-type
                    status: 400
                    title: Wrong AdditionalValueType
                    detail: Die angegebene Zusatzfeldart entspricht nicht der vorhandenen Zusatzfeldart.
                    timestamp: '2024-09-26T11:57:01.261294600Z'
                    errors: []
        '404':
          description: Requested carrier setup does not exist.
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
        '500':
          description: Additional value already exists.
          content:
            application/json:
              examples:
                Requested additional value with the same id already exists.:
                  description: Requested additional value with the same id already exists.
                  value:
                    errorMessage: 'Commit der Transaktion ist fehlgeschlagen: Cannot commit changes: Zusatzfeld - [testD]: Es existiert bereits ein Eintrag für Zusatzfeld mit Dienstleister-Einrichtung ''UPS EMEA'' und Kürzel ''TEST12''.'
                    errorCause: 'Cannot commit changes: Zusatzfeld - [testD]: Es existiert bereits ein Eintrag für Zusatzfeld mit Dienstleister-Einrichtung ''UPS EMEA'' und Kürzel ''TEST12''.'
  /carrier-setups/{id}/application-url:
    get:
      tags:
      - CarrierSetup
      description: Returns the application URL of a carrier setup with the requested ID.
      operationId: getCarrierSetupApplicationURL
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      responses:
        '200':
          description: Successful call
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierSetupStatus'
              examples:
                Carrier setup application URL entry:
                  description: Carrier setup application URL entry
                  value:
                    url: http://pc-xddev0406:40080/as4carrierintegration/servlet/StartXPage/dl/DLCarrierSetupFolderACV?encrQuery=lXFp-6SbTQ2tdV_SSn01iR-YvtEWfL_BChC6HJJ8Huexv8C1xtxJ1qCLxT2uZgHiZ1rTSVCcFxl621pLSUNptc4C143dN9biM-W75i4W_fcL2zFSH0HjO5C0_mnHQQ6KgRROHjWTJYp246QsvsM1wcZzTAnu-Sip-O14NAKmNcdbATaZclflQKbU6iHGI17mO2Ie1trOHwaAQRroqpxvO8zAaJAPl7B1lA-hb4j3ZLZqhJsGhlSkfFSdj5fSYeSPOS9jx9TNVrU3rN3vU3XFWnA
        '404':
          description: Requested carrier setup does not exist
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
  /carrier-setups/{id}/carrier-info-texts:
    get:
      tags:
      - CarrierSetup
      description: Returns all carrier info text setups of a carrier setup.
      operationId: getCarrierInfoTextSetups
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierInfoTextSetupPage'
              examples:
                Carrier info text setup list:
                  description: Carrier info text setup list
                  value:
                    totalElements: 4
                    content:
                    - identCode: HID
                      isEnabled: true
                      isDeprecated: false
                    - identCode: SHP
                      isEnabled: true
                      isDeprecated: false
                    - identCode: TSR
                      isEnabled: true
                      isDeprecated: false
                    - identCode: TEST
                      isEnabled: false
                      isDeprecated: false
        '404':
          description: Requested carrier setup does not exist.
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
    put:
      tags:
      - CarrierSetup
      description: Create or update all carrier info text setups of a carrier setup with the requested ID. If the carrier info text setup with the given ID does not exist, a new carrier info text setup will be created. If the carrier info text setup exist, the existing carrier info text setup is fully updated. Not filled fields in the request are treated thereby as empty data fields and lead to empty fields in an existing carrier info text setup. It is therefore recommended to use the GET/carrier-setups/{id}/carrier-info-texts to check whether a carrier info text setup with an ID already exists BEFORE you use PUT/carrier-setups/{id}/carrier-info-texts.
      operationId: createOrUpdateAllCarrierInfoTextSetups
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      requestBody:
        content:
          application/json:
            schema:
              type: string
            examples:
              Carrier info text setup list request:
                description: Carrier info text setup list request
                value:
                  totalElements: 4
                  content:
                  - identCode: HID
                    isEnabled: true
                    isDeprecated: false
                  - identCode: SHP
                    isEnabled: true
                    isDeprecated: false
                  - identCode: TSR
                    isEnabled: true
                    isDeprecated: false
                  - identCode: TEST
                    isEnabled: false
                    isDeprecated: false
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarrierInfoTextSetupPage'
              examples:
                Carrier info text setup list:
                  description: Carrier info text setup list
                  value:
                    totalElements: 4
                    content:
                    - identCode: HID
                      isEnabled: true
                      isDeprecated: false
                    - identCode: SHP
                      isEnabled: true
                      isDeprecated: false
                    - identCode: TSR
                      isEnabled: true
                      isDeprecated: false
                    - identCode: TEST
                      isEnabled: false
                      isDeprecated: false
        '409':
          description: Locking error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AebProblem'
              examples:
                Carrier setup is locked:
                  description: Carrier setup is locked
                  value:
                    type: about:blank
                    status: 409
                    title: Locked
                    detail: Locking für Dienstleister-Einrichtung - [UPS EMEA] fehlgeschlagen.
                    timestamp: '2024-09-26T11:33:35.095908100Z'
                    errors: []
        '404':
          description: Requested carrier setup does not exist.
          content:
            application/json:
              examples:
                Carrier setup not found:
                  description: Carrier setup not found
                  value:
                    errorMessage: Keine Dienstleister-Einrichtung mit der ID 'SCHENKER_ROAD' gefunden.
  /carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}:
    get:
      tags:
      - CarrierSetup
      description: Returns a carrier info text setup of a carrier setup with the requested ID.
      operationId: getCarrierInfoTextSetup
      parameters:
      - name: id
        in: path
        description: The requested ID of a carrier setup.
        required: true
        schema:
          type: string
        example: UPS
      - name: carrier-info-text-id
        in: path
        description: The requested ID of a carrier info text setup.
        required: true
        schema:
          type: string
        example: HAN
      responses:
        '200':
          description: Successful call.
          content:
            application/json:
              schema:
             

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-carriersetup-api-openapi.yml