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
servers:
- url: https://{tenant}.api.fulfillmenttools.com
variables:
tenant:
default: your-tenant-name
paths:
/api/articles:
get:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Search articles tenant-wide based on title or tenantArticleId
operationId: getArticles
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: query
name: facilityRef
required: false
schema:
type: string
- in: query
name: searchTerm
required: false
schema:
minLength: 1
type: string
- in: query
name: locale
required: false
schema:
$ref: '#/components/schemas/SupportedLocale'
- in: query
name: tenantArticleId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryArticlePaginatedResult'
description: >-
Articles search result according to the request. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List articles
tags:
- Stocks (Inventory)
/api/articles/{tenantArticleId}/forecasts:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
the forecast for a specific tenantArticleId
operationId: getForecastsForArticle
parameters:
- in: path
name: tenantArticleId
required: true
schema:
type: string
- in: query
name: period
required: false
schema:
enum:
- DAILY
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ArticleStockForecast'
type: array
description: >-
Forecast for the specified tenantArticleId. The result is in the
body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get article forecast
tags:
- Stocks (Inventory)
x-badges:
- color: red
label: ALPHA
/api/articles/{tenantArticleId}/stockdistribution:
get:
deprecated: false
description: >-
Stock per Facility for a specific tenantArticleId, also includes the
Tenant-Wide Summary
operationId: getStockDistribution
parameters:
- in: path
name: tenantArticleId
required: true
schema:
minLength: 1
type: string
- explode: false
in: query
name: facilityServiceTypes
required: false
schema:
items:
enum:
- SHIP_FROM_STORE
- PICKUP
type: string
type: array
- explode: false
in: query
name: facilityStatus
required: false
schema:
items:
enum:
- ONLINE
- SUSPENDED
- OFFLINE
type: string
type: array
- in: query
name: facilityName
required: false
schema:
minLength: 1
type: string
- explode: true
in: query
name: facilityIds
required: false
schema:
items:
type: string
type: array
- description: >-
The channels to included under "channelAdjusted" in each summary and
facility stock. Provide up to 50 channelRefs, specify "UNALLOCATED
for unallocated stock."
explode: true
in: query
name: channelRefs
required: false
schema:
items:
type: string
maxItems: 50
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockDistribution'
description: >-
Stock distribution was loaded & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get article stock distribution
tags:
- Stocks (Inventory)
/api/audits:
get:
deprecated: false
description: ''
operationId: getAudits
parameters:
- in: query
name: size
required: false
schema:
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: query
name: entityRef
required: false
schema:
type: string
- explode: false
in: query
name: entityType
required: false
schema:
enum:
- PACK_JOB
- PICK_JOB
- PICK_RUN
- HANDOVER_JOB
- SHIPMENT
- PARCEL
- CUSTOM_SERVICE
- SERVICE_JOB
- LINKED_SERVICE_JOBS
- ORDER
- ROUTING_PLAN
- FACILITY
- FACILITY_GROUP
- FACILITY_CARRIER_CONNECTION
- FACILITY_CUSTOM_SERVICE
- ROUTING_STRATEGY
- STOW_JOB
type: string
- in: query
name: trace
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuditsResult'
description: Paginated result containing the matching Audit entities
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List audits
tags:
- Audits (Core)
/api/availabilitychannels:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getAvailabilityChannels
parameters:
- in: query
name: searchTerm
required: false
schema:
type: string
- in: query
name: searchTermExact
required: false
schema:
type: string
- in: query
name: strategy
required: false
schema:
enum:
- REGULAR
- IRON_RESERVE
- RESTRICT
type: string
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannelPaginatedResult'
description: Available Availability Channels
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List availability channels
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createAvailabilityChannel
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannelForCreation'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannel'
description: The created Availability Channel
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create availability channel
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
/api/availabilitychannels/{availabilityChannelId}:
delete:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Delete an existing Availability Channel. PLEASE NOTE: This will also
delete all groups and allocations under this channel.
operationId: deleteAvailabilityChannel
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
responses:
'200':
description: The channel has been deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete availability channel
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getAvailabilityChannelById
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannel'
description: The Availability Channel
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get availability channel
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: replaceAvailabilityChannel
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannelForReplacement'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannel'
description: The replaced Availability Channel
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update availability channel
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
/api/availabilitychannels/{availabilityChannelId}/groups:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getGroupsUnderChannel
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
- in: query
name: searchTerm
required: false
schema:
type: string
- in: query
name: searchTermExact
required: false
schema:
type: string
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: >-
#/components/schemas/AvailabilityAllocationGroupPaginatedResult
description: Available Groups
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: List channel groups
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createGroupUnderChannel
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/AvailabilityAllocationGroupForCreationUnderChannel
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationGroup'
description: The created Group
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Create channel group
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}:
delete:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Delete an existing Group and all its allocations under Channel
operationId: deleteGroupUnderChannel
parameters:
- in: path
name: groupId
required: true
schema:
type: string
- in: path
name: availabilityChannelId
required: true
schema:
type: string
responses:
'200':
description: The Group has been deleted.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete channel group
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
Groups under Channel by its ID
operationId: getGroupUnderChannelById
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
- in: path
name: groupId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: >-
#/components/schemas/AvailabilityAllocationGroupPaginatedResult
description: The Group
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get channel group
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: replaceGroupUnderChannel
parameters:
- in: path
name: availabilityChannelId
required: true
schema:
type: string
- in: path
name: groupId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationGroupForReplacement'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationGroup'
description: The replaced Group
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update channel group
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getAllocationsUnderGroup
parameters:
- in: path
name: groupId
required: true
schema:
type: string
- in: path
name: availabilityChannelId
required: true
schema:
type: string
- in: query
name: searchTerm
required: false
schema:
type: string
- in: query
name: searchTermExact
required: false
schema:
type: string
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationPaginatedResult'
description: Available Allocations
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: List group allocations
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createAllocationUnderGroup
parameters:
- in: path
name: groupId
required: true
schema:
type: string
- in: path
name: availabilityChannelId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationForCreationUnderGroup'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocation'
description: The created Allocation
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Create group allocation
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}:
delete:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: deleteAllocationUnderGroup
parameters:
- in: path
name: allocationId
required: true
schema:
type: string
- in: path
name: groupId
required: true
schema:
type: string
- in: path
name: availabilityChannelId
required: true
schema:
type: string
responses:
'200':
description: The Allocation has been deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete group allocation
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getAllocationUnderGroupById
parameters:
- in: path
name: groupId
required: true
schema:
type: string
- in: path
name: allocationId
required: true
schema:
type: string
- in: path
name: availabilityChannelId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocation'
description: The Allocation
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: List group allocations
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: replaceAllocationUnderGroup
parameters:
- in: path
name: groupId
required: true
schema:
type: string
- in: path
name: allocationId
required: true
schema:
type: string
- in: path
name: availabilityChannelId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationForReplacement'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocation'
description: The replaced Allocation
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update group allocation
tags:
- Channel Availability (Inventory)
x-badges:
- color: red
label: ALPHA
/api/brands:
get:
description: ''
operationId: getAllBrands
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedBrands'
description: All brands on listings for this tenant
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List brands
tags:
- Processes (Core)
/api/cancelationreasons:
get:
description: ''
operationId: getCancelationReasons
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CancelationReasons'
description: >-
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
summary: List cancelation reasons
tags:
- Orders Configuration (DOMS)
post:
operationId: postCancelationReason
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CancelationReasonForCreation'
description: Create new cancelation reason
required: true
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
summary: Create cancelation reason
tags:
- Orders Configuration (DOMS)
/api/cancelationreasons/{cancelationReasonId}:
delete:
description: ''
operationId: deleteCancelationReason
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
summary: Delete cancelation reason
tags:
- Orders Configuration (DOMS)
get:
description: ''
operationId: getCancelationReasonById
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
summary: Get cancelation reason
tags:
- Orders Configuration (DOMS)
put:
description: ''
operationId: putCancelationReason
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
summary: Update cancelation reason
tags:
- Orders Configuration (DOMS)
/api/carriers:
get:
description: ''
operationId: getCarriers
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No more elements available
summary: List carriers
tags:
- Carriers (Operations)
post:
description: ''
operationId: addCarrier
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierForCreation'
description: Carrier object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
description: >-
The carrier was successfully created. The Location header contains
the URL of the carrier.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create carrier
tags:
- Carriers (Operations)
/api/carriers/{carrierId}:
get:
description: ''
operationId: getCarrier
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: User not found
summary: Get carrier
tags:
- Carriers (Operations)
patch:
description: ''
operationId: patchCarrier
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
description: >-
Carrier was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update carrier
tags:
- Carriers (Operations)
/api/carriers/{carrierId}/configuration:
get:
description: ''
operationId: getCarrierConfiguration
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'
- $ref: '#/components/schemas/SevenSendersCarrierConfiguration'
- $ref: '#/components/schemas/UBSendCarrierConfiguration'
description: >-
Carrier Configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier Configuration not found
summary: Get carrier config
tags:
- Carriers Configuration (Operations)
put:
description: ''
operationId: putCarrierConfiguration
parameters:
- description: ID of the carrier you want to update the configuration
in: path
name: carrierId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/CarrierConfiguration'
- $ref: '#/components/schemas/GlsCarrierConfiguration'
- $ref: '#/components/schemas/FedexCarrierConfiguration'
- $ref: '#/components/schemas/BringCarrierConfiguration'
- $ref: '#/components/schemas/DpdChCarrierConfiguration'
- $ref: '#/components/schemas/DhlV2CarrierConfiguration'
- $ref: '#/components/schemas/VceCarrierConfiguration'
- $ref: '#/components/schemas/PostNlCarrierConfiguration'
- $ref: '#/components/schemas/SevenSendersCarrierConfiguration'
- $ref: '#/components/schemas/UBSendCarrierConfiguration'
description: Carrier Configuration
required: true
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'
- $ref: '#/components/schemas/SevenSendersCarrierConfiguration'
- $ref: '#/components/schemas/UBSendCarrierConfiguration'
description: >-
Carrier Configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier Configuration not found
summary: Update carrier config
tags:
- Carriers Configuration (Operations)
/api/carriers/{carrierId}/configuration/countryservicemappings:
get:
description: ''
operationId: getCarrierCountryServiceMappings
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier's countryservicemappings Configuration not found
summary: List country service mappings
tags:
- Carriers Configuration (Operations)
post:
description: ''
operationId: createCarrierCountryServiceMapping
parameters:
- description: ID of the carrier you want to create a countryservicemapping for
in: path
name: carrierId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMappingForCreation'
description: Carrier Configuration
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMapping'
description: >-
CarrierCountryServiceMapping successfully created. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier not found
summary: Create country service mapping
tags:
- Carriers Configuration (Operations)
/api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}:
delete:
description: ''
operationId: deleteCarrierCountryServiceMapping
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier or CarrierCountryServiceMapping not found
summary: Delete country service mapping
tags:
- Carriers Configuration (Operations)
get:
description: ''
operationId: getCarrierCountryServiceMapping
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier's countryservicemappings Configuration not found
summary: Get country service mapping
tags:
- Carriers Configuration (Operations)
patch:
description: ''
operationId: updateCarrierCountryServiceMapping
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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMappingForUpdate'
description: Carrier Mapping for update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMapping'
description: >-
CarrierCountryServiceMapping successfully updated. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carrier or CarrierCountryServiceMapping not found
summary: Update country service mapping
tags:
- Carriers Configuration (Operations)
/api/categories:
get:
deprecated: false
description: ''
operationId: getCategories
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Category'
type: array
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List categories
tags:
- Categories (Inventory)
post:
deprecated: false
description: ''
operationId: createCategory
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create category
tags:
- Categories (Inventory)
/api/categories/{categoryId}:
delete:
deprecated: false
description: ''
operationId: deleteCategory
parameters:
- in: path
name: categoryId
required: true
schema:
type: string
- in: query
name: forceDeletion
required: false
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Delete category
tags:
- Categories (Inventory)
get:
deprecated: false
description: ''
operationId: getCategory
parameters:
- in: path
name: categoryId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get category
tags:
- Categories (Inventory)
put:
deprecated: false
description: ''
operationId: replaceCategory
parameters:
- in: path
name: categoryId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryForUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Replace category
tags:
- Categories (Inventory)
/api/categories/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Category
operationId: searchCategory
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CategorySearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List categories (search)
tags:
- Categories (Inventory)
x-badges:
- color: orange
label: BETA
/api/configurations/capacityplanningtimeframe:
get:
description: ''
operationId: getCapacityPlanningTimeframeConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
description: >-
Configuration was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get capacity planning timeframe
tags:
- Routing Plans Configuration (DOMS)
put:
description: ''
operationId: putCapacityPlanningTimeframeConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
description: Configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update capacity planning timeframe
tags:
- Routing Plans Configuration (DOMS)
/api/configurations/cutofftime:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getCutoffTimeConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CutoffTimeConfiguration'
description: >-
Cutoff time configuration was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Cutoff time configuration not found
summary: Get cutoff time
tags:
- Picking Configuration (Operations)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: putCutoffTimeConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CutoffTimeConfiguration'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CutoffTimeConfiguration'
description: Cutoff time configuration was written successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Cutoff time configuration not found
summary: Update cutoff time
tags:
- Picking Configuration (Operations)
x-badges:
- color: orange
label: BETA
/api/configurations/deliverynote:
get:
operationId: getDeliveryNoteConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfiguration'
description: >-
Delivery note configuration was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Delivery note configuration not found
summary: Get delivery note config
tags:
- Shipments Configuration (Operations)
put:
operationId: putDeliveryNoteConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfigurationForUpsert'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfiguration'
description: Delivery note configuration was successfully updated
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfiguration'
description: Delivery note configuration was successfully created
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update delivery note config
tags:
- Shipments Configuration (Operations)
/api/configurations/domain:
get:
description: Returns the authentication domain.
operationId: getDomainConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: Domain config could be found in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get domain
tags:
- Artifacts (Infrastructure)
put:
description: Updates the authentication domain.
operationId: putDomainConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: Desired domain note configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: The domain configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: The domain configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update domain
tags:
- Artifacts (Infrastructure)
/api/configurations/expiry:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getExpiryConfiguration
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
summary: Get expiry config
tags:
- Expiries Configuration (Core)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: upsertExpiryConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: Desired configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: The configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: The configuration was successfully created.
'400':
content:
application/json:
schema:
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
summary: Update expiry config
tags:
- Expiries Configuration (Core)
x-badges:
- color: orange
label: BETA
/api/configurations/fulfillmentprocessbuffer:
get:
description: ''
operationId: getFulfillmentProcessBufferConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
description: >-
Configuration was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Configuration not found
summary: Get fulfillment process buffer
tags:
- Picking Configuration (Operations)
put:
description: ''
operationId: putFulfillmentProcessBufferConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
description: Configuration was written successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Configuration not found
summary: Update fulfillment process buffer
tags:
- Picking Configuration (Operations)
/api/configurations/gdpr:
get:
description: ''
operationId: getGdprConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GdprConfiguration'
description: >-
Gdpr configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Gdpr configuration not found
summary: Get GDPR config
tags:
- Configurations (Core)
put:
description: ''
operationId: putGdprConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GdprConfiguration'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GdprConfiguration'
description: Gdpr configuration was written successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Gdpr configuration not found
summary: Update GDPR config
tags:
- Configurations (Core)
/api/configurations/handover:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the handover configuration for the tenant
operationId: getHandoverConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverConfiguration'
description: >-
Handover configuration was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get handover config
tags:
- Handovers Configuration (Operations)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Updates the handover configuration for the tenant. If the
configuration does not exist, it will be created.
operationId: upsertHandoverConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverConfigurationForCreate'
description: Desired HandoverConfiguration
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverConfiguration'
description: The handover configuration was successfully updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update handover configuration
tags:
- Handovers Configuration (Operations)
x-badges:
- color: orange
label: BETA
/api/configurations/handover/refusereasons:
get:
description: ''
operationId: getAllRefuseReasons
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AvailableRefusedReason'
type: array
description: Existing refuse reasons
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List refuse reasons
tags:
- Handovers Configuration (Operations)
/api/configurations/inventory:
get:
deprecated: false
description: ''
operationId: getInventoryConfigurations
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryConfiguration'
description: Requested Inventory Configuration
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get inventory config
tags:
- Stocks Configuration (Inventory)
patch:
deprecated: false
description: ''
operationId: upsertInventoryConfigurations
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryConfigurationForPatch'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryConfiguration'
description: Requested Inventory Configuration
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update inventory config
tags:
- Stocks Configuration (Inventory)
/api/configurations/loadunit:
get:
operationId: getLoadUnitConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: The load unit configuration can be found in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get load unit config
tags:
- Picking Configuration (Operations)
put:
description: ''
operationId: putLoadUnitConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: Desired load unit configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: The load unit configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: The load unit configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update load unit config
tags:
- Picking Configuration (Operations)
/api/configurations/locale:
get:
description: ''
operationId: getLocaleConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocaleConfiguration'
description: The locale Configuration can be found in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get locale config
tags:
- Configurations (Core)
put:
description: ''
operationId: putLocaleConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LocaleConfiguration'
description: Desired default locale configuration to put
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocaleConfiguration'
description: The locale Configuration was successfully set.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update locale config
tags:
- Configurations (Core)
/api/configurations/notifications:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Returns the notification center configuration.
operationId: getNotificationCenterConfig
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: The notification center configuration was successfully returned.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get notification config
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Update the notification center configuration.
operationId: upsertNotificationCenterConfig
parameters: []
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
- allOf:
- $ref: '#/components/schemas/NotificationCenterConfigForCreation'
not:
required:
- version
type: object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: Notification center configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: Notification center configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Update notification config
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
/api/configurations/notifications/actions:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Executes an action to manipulate the notification center
configuration.
operationId: executeNotificationCenterConfigAction
parameters: []
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AddChannelAction'
- $ref: '#/components/schemas/UpdateChannelByIdAction'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: Notification center configuration action was successfully executed.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Call notification action
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
/api/configurations/notifications/channels/{channelId}:
delete:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Delete the notification channel.
operationId: deleteNotificationCenterConfigChannel
parameters:
- in: path
name: channelId
required: true
schema:
type: string
- in: query
name: version
required: true
schema:
type: number
responses:
'200':
description: Notification center config channel was successfully deleted.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Delete notification channel
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
/api/configurations/oidcproviders:
get:
deprecated: false
description: Return a complete list of all configured OIDC providers.
operationId: getOidcProviders
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviders'
description: Existing oidc providers.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get OIDC providers
tags:
- OIDC Configuration (Infrastructure)
post:
deprecated: false
description: >-
Registers an external OIDC provider so the platform can interact with it
for user authentication.
operationId: createOidcProvider
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviderForCreation'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedOidcProvider'
description: Provider was found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Create OIDC provider
tags:
- OIDC Configuration (Infrastructure)
/api/configurations/oidcproviders/{oidcProviderId}:
delete:
deprecated: false
description: >-
Removes an OIDC provider configuration, disabling the platform’s ability
to authenticate via that provider.
operationId: deleteOidcProvider
parameters:
- in: path
name: oidcProviderId
required: true
schema:
type: string
responses:
'200':
description: OIDC Provider was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete OIDC provider
tags:
- OIDC Configuration (Infrastructure)
get:
deprecated: false
description: Get the configuration of a configured OIDC provider.
operationId: getOidcProvider
parameters:
- in: path
name: oidcProviderId
required: true
schema:
type: string
responses:
'201':
description: The users was successfully created.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get OIDC provider
tags:
- OIDC Configuration (Infrastructure)
patch:
deprecated: false
description: >-
Change the configuration of an already configured OIDC provider. Only
the specified values are changed.
operationId: patchOidcProvider
parameters:
- in: path
name: oidcProviderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviderForPatch'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedOidcProvider'
description: Provider was patched successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update OIDC provider
tags:
- OIDC Configuration (Infrastructure)
put:
deprecated: false
description: >-
Change the configuration of an already configured OIDC provider. The
configuration has to contain all necessary values.
operationId: updateOidcProvider
parameters:
- in: path
name: oidcProviderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviderForUpdate'
required: true
responses:
'200':
description: Provider was updated successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update OIDC provider
tags:
- OIDC Configuration (Infrastructure)
/api/configurations/operativerestowing:
get:
operationId: getOperationalRestowingConfigurations
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalRestowingConfigurations'
description: Configuration of all restow item related things
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get restow config
tags:
- Restowing Configuration (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
patch:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: putOperationalRestowingConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalRestowingConfigurations'
description: create/update operational restowing configurations
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalRestowingConfigurations'
description: The restowing configurations were successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OperationalRestowingConfigurations'
description: The restowing configurations were successfully created.
'400':
content:
application/json:
schema:
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
summary: Update restow config
tags:
- Restowing Configuration (Operations)
x-badges:
- color: red
label: ALPHA
/api/configurations/operativeservice:
get:
operationId: getOperativeServiceConfiguration
parameters:
- description: >-
Provide the localized names and descriptions for operative service
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/OperativeServiceConfiguration'
description: Central Configuration of all Service related operations
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get operative service config
tags:
- Services Configuration (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
put:
operationId: upsertOperativeServiceConfigurations
parameters:
- description: >-
Provide the localized names and descriptions for the operative
service configuration.
If not provided the default locale is used. for
example de_DE.
in: query
name: locale
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeServiceConfigurationForUpsert'
description: create/update operative service configuration
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeServiceConfiguration'
description: The operative service configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeServiceConfiguration'
description: The operative service configuration was successfully created.
'400':
content:
application/json:
schema:
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
summary: Update operative service config
tags:
- Services Configuration (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/configurations/ordercancelation:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getOrderCancelationConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderCancelationConfiguration'
description: The Order Cancelation Configuration can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get order cancelation config
tags:
- Orders Configuration (DOMS)
x-badges:
- color: orange
label: BETA
put:
description: ''
operationId: putOrderCancelationConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderCancelationConfiguration'
description: Desired order cancelation configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderCancelationConfiguration'
description: The order cancelation configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderCancelationConfiguration'
description: The order cancelation configuration was successfully created.
'400':
content:
application/json:
schema:
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
summary: Update order cancelation config
tags:
- Orders Configuration (DOMS)
/api/configurations/ordermodification:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getOrderModificationConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderModificationConfiguration'
description: The Order Modification Configuration can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get order modification config
tags:
- Orders Configuration (DOMS)
x-badges:
- color: orange
label: BETA
put:
description: ''
operationId: putOrderModificationConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderModificationConfiguration'
description: Desired order modification configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderModificationConfiguration'
description: The order modification configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderModificationConfiguration'
description: The order modification configuration was successfully created.
'400':
content:
application/json:
schema:
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
summary: Update order modification config
tags:
- Orders Configuration (DOMS)
/api/configurations/orderrouting:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getOrderRoutingConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: The Order Routing Configuration can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get order routing config
tags:
- Routing Plans Configuration (DOMS)
x-badges:
- color: orange
label: BETA
put:
description: ''
operationId: putOrderRoutingConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: Desired order routing configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: The order routing configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: The order routing configuration was successfully created.
'400':
content:
application/json:
schema:
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
summary: Update order routing config
tags:
- Routing Plans Configuration (DOMS)
/api/configurations/packing:
get:
operationId: getPackingConfigurations
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: Central Configuration of all packing related things
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get packing config
tags:
- Packing Configuration (Operations)
patch:
description: ''
operationId: upsertPackingConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: create/update packing central configuration
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: The packing central configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: The packing central configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update packing config
tags:
- Packing Configuration (Operations)
/api/configurations/packing/containerrequired:
get:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Deprecated, will be replaced with /api/configurations/packing
operationId: getPackingContainerRequirement
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: The requirement of containers in packing can be found in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get packing container requiremed config
tags:
- Packing Configuration (Operations)
put:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Deprecated, will be replaced with /api/configurations/packing
operationId: putPackingContainerRequirement
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: Validation picking scan code to activate/deactivate
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: >-
The packing container requirement configuration was successfully
updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: >-
The packing container requirement configuration was successfully
created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update packing container required config
tags:
- Packing Configuration (Operations)
/api/configurations/picking:
get:
operationId: getPickingConfigurations
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: Central Configuration of all picking related things
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get picking config
tags:
- Picking Configuration (Operations)
patch:
description: ''
operationId: putPickingConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: Update picking central configuration
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: The picking central configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: The picking central configuration was successfully created.
'400':
content:
application/json:
schema:
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
summary: Update picking config
tags:
- Picking Configuration (Operations)
/api/configurations/pickingtimes:
get:
description: ''
operationId: getDefaultPickingTimesConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultPickingTimesConfiguration'
description: Picking Times config found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get picking times
tags:
- Picking Configuration (Operations)
put:
description: ''
operationId: putDefaultPickingTimesConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultPickingTimesConfiguration'
description: Desired default picking times configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultPickingTimesConfiguration'
description: The default picking times configuration was successfully updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Configuration version conflict
summary: Update picking times
tags:
- Picking Configuration (Operations)
/api/configurations/promises:
get:
description: ''
operationId: getPromisesConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PromisesConfiguration'
description: >-
Promises configuration was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List promises
tags:
- Orders Configuration (DOMS)
put:
description: ''
operationId: putPromisesConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromisesConfiguration'
description: Desired promises configuration to put
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PromisesConfiguration'
description: The promisesConfiguration was successfully put.
'400':
content:
application/json:
schema:
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
summary: Change promises config
tags:
- Orders Configuration (DOMS)
/api/configurations/return:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the current return configuration for the tenant.
operationId: getReturnConfiguration
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
summary: Get returns config
tags:
- Returns Configuration (Operations)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Updates the return configuration for the tenant. If no configuration
exists, it will be created.
operationId: upsertReturnConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnConfiguration'
description: Desired return configuration to create/update
required: true
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
summary: Update returns config
tags:
- Returns Configuration (Operations)
x-badges:
- color: orange
label: BETA
/api/configurations/returnnote:
get:
operationId: getReturnNoteConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfiguration'
description: Return note config could be found in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get return note config
tags:
- Shipments Configuration (Operations)
put:
description: ''
operationId: putReturnNoteConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfigurationForUpsert'
description: Desired return note configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfiguration'
description: The return note configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfiguration'
description: The return note configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update return note config
tags:
- Shipments Configuration (Operations)
/api/configurations/stock:
get:
description: ''
operationId: getStockConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfiguration'
description: StockConfiguration config found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get stock config
tags:
- Stocks Configuration (Inventory)
put:
description: ''
operationId: putStockConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfiguration'
description: Desired stock configuration to put
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfiguration'
description: The stockConfiguration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update stock config
tags:
- Stocks Configuration (Inventory)
/api/configurations/substitution:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getSubstitutionConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: Substitution config found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get substitution config
tags:
- Picking Configuration (Operations)
x-badges:
- color: orange
label: BETA
put:
description: ''
operationId: putSubstitutionConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: Desired substitution configuration to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: The substitution configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: The substitution configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
summary: Update substitution config
tags:
- Picking Configuration (Operations)
/api/configurations/supportedlocales:
get:
description: ''
operationId: getLocales
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SupportedLocales'
description: The supported locales can be found in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List supported locales
tags:
- Configurations (Core)
/api/configurations/tags/handoverjob:
get:
description: ''
operationId: getHandoverJobTagConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobTagConfiguration'
description: handoverJob tag config is in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get handover jobs tag config
tags:
- Handovers Configuration (Operations)
put:
description: ''
operationId: putHandoverTagConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobTagConfiguration'
description: Desired Tag Configuration for HandoverJobs
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobTagConfiguration'
description: The handoverjob tag configuration was successfully updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update handover jobs tag config
tags:
- Handovers Configuration (Operations)
/api/configurations/tags/order:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getOrderTagConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTagConfiguration'
description: order tag config is in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get order tag configuration
tags:
- Orders Configuration (DOMS)
x-badges:
- color: orange
label: BETA
put:
description: ''
operationId: putOrderTagConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTagConfiguration'
description: Desired Tag Configuration for orders
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTagConfiguration'
description: The order tag configuration was successfully updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update order tag configuration
tags:
- Orders Configuration (DOMS)
/api/configurations/tags/packjob:
get:
description: ''
operationId: getPackJobTagConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobTagConfiguration'
description: Packjob tag config is in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack jobs tag config
tags:
- Packing Configuration (Operations)
put:
description: ''
operationId: putPackJobTagConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobTagConfiguration'
description: Desired PackJobTagConfiguration
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobTagConfiguration'
description: The packing configuration was successfully updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update pack jobs tag config
tags:
- Packing Configuration (Operations)
/api/configurations/tags/parcel:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the tag configuration for parcels
operationId: getParcelTagConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelTagConfiguration'
description: tag config is in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get parcel tag config
tags:
- Shipments Configuration (Operations)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Updates the tag configuration for parcels.
operationId: putParcelTagConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelTagConfigurationForUpsert'
description: Desired Tag Configuration for Parcels
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelTagConfiguration'
description: The tag configuration was successfully updated.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update parcel tag config
tags:
- Shipments Configuration (Operations)
x-badges:
- color: orange
label: BETA
/api/configurations/tags/pickjob:
get:
description: ''
operationId: getPickJobTagConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobTagConfiguration'
description: pickjob tag config is in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get pick job tag config
tags:
- Picking Configuration (Operations)
put:
description: ''
operationId: putPickJobTagConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobTagConfiguration'
description: Desired Tag Configuration for Pickjobs
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobTagConfiguration'
description: The packing configuration was successfully updated.
'400':
content:
application/json:
schema:
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
summary: Update pick job tag config
tags:
- Picking Configuration (Operations)
/api/configurations/tenant:
get:
description: ''
operationId: getTenantConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfiguration'
description: >-
Tenant configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Tenant configuration not found
summary: Get tenant config
tags:
- Configurations (Core)
put:
description: Upsert tenant configuration
operationId: putTenantConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfigurationForUpsert'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfiguration'
description: Tenant configuration was written successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Tenant configuration not found
summary: Update tenant config
tags:
- Configurations (Core)
/api/configurations/tenantconnector:
get:
deprecated: false
description: ''
operationId: getTenantConnectorConfigurations
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConnectorConfigurations'
description: >-
Configuration was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: configuration not found
summary: Get tenant connector config
tags:
- Artifacts (Infrastructure)
/api/configurations/transittime:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getTransitTimeConfiguration
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransitTimeConfiguration'
description: >-
Transit time configuration was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Cutoff time configuration not found
summary: Get transit time config
tags:
- Carriers Configuration (Operations)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: putTransitTimeConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransitTimeConfigurationForUpsert'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransitTimeConfiguration'
description: Transit time configuration was written successfully
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Transit time configuration not found
summary: Update transit time config
tags:
- Carriers (Operations)
x-badges:
- color: orange
label: BETA
/api/customservices:
get:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getCustomServices
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
summary: List custom services
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
post:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createCustomService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomServiceForCreation'
description: Desired custom service to create
required: true
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
summary: Create custom service
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
/api/customservices/{customServiceId}:
get:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getCustomService
parameters:
- description: ID of custom service you want to get
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: Custom service 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
summary: Get custom service
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
patch:
operationId: patchCustomService
parameters:
- description: ID of custom service you want to patch
in: path
name: customServiceId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomServicePatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: >-
custom service was found & patch-set has been applied. The patched
custom service is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update custom service
tags:
- Custom Services (Core)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/customservices/{customServiceId}/additionalinformation:
post:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createCustomServiceAdditionalInformation
parameters:
- description: ID of custom service you want to create service job for
in: path
name: customServiceId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalInformationForCreation'
description: Desired custom service to create
required: true
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
summary: Create additional information
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
/api/customservices/{customServiceId}/additionalinformation/{additionalInformationId}:
delete:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: deleteAdditionalInfo
parameters:
- description: ID of custom service
in: path
name: customServiceId
required: true
schema:
type: string
- description: ID of additional information you want to delete
in: path
name: additionalInformationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully updated.
'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
summary: Delete additional information
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
put:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: updateCustomServiceAdditionalInformation
parameters:
- description: ID of custom service
in: path
name: customServiceId
required: true
schema:
type: string
- description: ID of additional information you want to put
in: path
name: additionalInformationId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalInformationForCreation'
description: Desired custom service to create
required: true
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
summary: Update additional information
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
/api/deliverynotes:
post:
operationId: createDeliveryNote
parameters:
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE
in: query
name: locale
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNote'
required: true
responses:
'201':
content:
application/pdf:
schema:
$ref: '#/components/schemas/DeliveryNote'
description: Successfully created the delivery note.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create delivery note
tags:
- Shipments (Operations)
/api/documents/{documentId}/file:
get:
description: ''
operationId: downloadProcessDocument
parameters:
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
description: The document with given id
summary: Get file
tags:
- Processes (Core)
/api/documentSet/{documentSetRef}:
get:
deprecated: true
description: Deprecated, use /api/documentsets/{documentSetRef} instead
operationId: getDocumentSetDeprecated
parameters:
- description: Reference to the entity you want to get
in: path
name: documentSetRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSet'
description: Documents were found. The results are in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get document set
tags:
- Document Sets (Core)
/api/documentSet/{documentSetRef}/documents:
post:
deprecated: true
description: Deprecated, use /api/documentsets/{documentSetRef}/documents instead
operationId: addDocumentDeprecated
parameters:
- description: Reference to the documentSet you want to add a file to
in: path
name: documentSetRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalPrintableDocumentForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Document was found. The results are in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Create document
tags:
- Document Sets (Core)
/api/documentSet/{documentSetRef}/documents/{documentRef}:
patch:
deprecated: true
description: >-
Deprecated, use
/api/documentsets/{documentSetRef}/documents/{documentRef} instead
operationId: updateDocumentDeprecated
parameters:
- description: Reference to the documentSet you want to update
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to update
in: path
name: documentRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocumentForUpdate'
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update document
tags:
- Document Sets (Core)
/api/documentSet/{documentSetRef}/documents/{documentRef}/file:
get:
description: ''
operationId: downloadDocumentDeprecated
parameters:
- description: Reference to the documentSet you want to download a file from
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to download
in: path
name: documentRef
required: true
schema:
type: string
responses:
'200':
description: The document as a stream
summary: Get file
tags:
- Document Sets (Core)
put:
deprecated: true
description: >-
Deprecated, use
/api/documentsets/{documentSetRef}/documents/{documentRef}/file instead
operationId: addContentToDocumentDeprecated
parameters:
- description: Reference to the documentSet you want to update
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to update
in: path
name: documentRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentContentForUpdate'
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update file
tags:
- Document Sets (Core)
/api/documentsets/{documentSetRef}:
get:
description: ''
operationId: getDocumentSet
parameters:
- description: Reference to the entity you want to get
in: path
name: documentSetRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSet'
description: Documents were found. The results are in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get document set
tags:
- Document Sets (Core)
/api/documentsets/{documentSetRef}/documents:
post:
operationId: addDocument
parameters:
- description: Reference to the documentSet you want to add a file to
in: path
name: documentSetRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalPrintableDocumentForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Document was found. The results are in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Create document
tags:
- Document Sets (Core)
/api/documentsets/{documentSetRef}/documents/{documentRef}:
patch:
operationId: updateDocument
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update document
tags:
- Document Sets (Core)
/api/documentsets/{documentSetRef}/documents/{documentRef}/file:
get:
description: ''
operationId: downloadDocument
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
summary: Get file
tags:
- Document Sets (Core)
put:
operationId: addContentToDocument
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update file
tags:
- Document Sets (Core)
/api/expiries:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getExpiries
parameters:
- description: Status to filter the results
in: query
name: status
required: false
schema:
$ref: '#/components/schemas/ExpiryEntityStatus'
- description: ProcessRef to filter the results
in: query
name: processRef
required: false
schema:
type: string
- description: >-
StartDate to filter the results. Expiry Date of results is after or
equals the given value
in: query
name: startDate
required: false
schema:
example: 2020-02-03T08:45:51.525Z
format: date-time
type: string
- description: >-
EndDate to filter the results. Expiry Date of results is before or
equals the given value
in: query
name: endDate
required: false
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExpiryEntity'
type: array
description: found entities in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get expiries
tags:
- Expiries (Core)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: createExpiry
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntityForCreation'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntity'
description: created entity in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create expiry
tags:
- Expiries (Core)
x-badges:
- color: orange
label: BETA
/api/expiries/{expiryId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getExpiry
parameters:
- description: id for the searched entity
in: path
name: expiryId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntity'
description: found entity in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get expiry
tags:
- Expiries (Core)
x-badges:
- color: orange
label: BETA
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: updateExpiry
parameters:
- description: id of the entity to be changed
in: path
name: expiryId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntityForUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntity'
description: changed entity in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update expiry
tags:
- Expiries (Core)
x-badges:
- color: orange
label: BETA
/api/externalactions:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns a list with all external actions.
operationId: getExternalActions
parameters:
- description: all entities after given Id.
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Filter by the given group or groups
explode: true
in: query
name: groups
required: false
schema:
items:
type: string
type: array
- description: Filter by the given processRef
in: query
name: processRef
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExternalAction'
type: array
description: Returning the list of external actions available.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List external actions
tags:
- External Actions (Core)
x-badges:
- color: orange
label: BETA
post:
description: Creates a new external action for a process.
operationId: postExternalAction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalActionForCreation'
description: The external action to be created
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAction'
description: The external action was successfully created.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Create external action
tags:
- External Actions (Core)
/api/externalactions/{externalActionId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: deleteExternalAction
parameters:
- description: ID of the external action that you want delete
in: path
name: externalActionId
required: true
schema:
type: string
responses:
'200':
description: External action was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Delete external action
tags:
- External Actions (Core)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns an external action with the given id if found.
operationId: getExternalAction
parameters:
- description: Id of the external action you want to get
in: path
name: externalActionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExternalAction'
type: array
description: >-
External action was found & you are allowed to get it. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get external action
tags:
- External Actions (Core)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Replaces the external action with the provided in the body.
operationId: putExternalAction
parameters:
- description: ID of the external action that you want update
in: path
name: externalActionId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalActionForReplacement'
description: Update external action
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExternalAction'
description: External action was found & you are allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Replace an external action
tags:
- External Actions (Core)
x-badges:
- color: orange
label: BETA
/api/externalactions/{externalActionId}/logs:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the logs related with the given external action.
operationId: getExternalActionLogs
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Id of the external action you want to get the logs from
in: path
name: externalActionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ExternalActionLogs'
type: array
description: >-
Logs were found & you are allowed to get it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List external action logs
tags:
- External Actions (Core)
x-badges:
- color: orange
label: BETA
post:
description: Creates a new external action log.
operationId: postExternalActionLog
parameters:
- description: ID of the external action you want to create the log for
in: path
name: externalActionId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalActionLogForCreation'
description: The external action log to be created
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalActionLog'
description: The log for the external action was successfully created.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Create external action logs
tags:
- External Actions (Core)
/api/externalstockchangereasons:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
external stock change reasons
operationId: getExternalStockChangeReasons
parameters: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalStockChangeReason'
description: List of external stock change reasons
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stock change reasons
tags:
- Stocks Configuration (Inventory)
x-badges:
- color: red
label: ALPHA
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Post external stock change reason.
operationId: postExternalStockChangeReason
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalStockChangeReasonForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalStockChangeReason'
description: The created external stock change reason
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create stock change reason
tags:
- Stocks Configuration (Inventory)
x-badges:
- color: red
label: ALPHA
/api/externalstockchangereasons/{externalStockChangeReasonId}:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
external stock change reason.
operationId: getExternalStockChangeReason
parameters:
- in: path
name: externalStockChangeReasonId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalStockChangeReason'
description: The external stock change reason
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get stock change reason
tags:
- Stocks Configuration (Inventory)
x-badges:
- color: red
label: ALPHA
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Update external stock change reason.
operationId: putExternalStockChangeReason
parameters:
- in: path
name: externalStockChangeReasonId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalStockChangeReasonForUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalStockChangeReason'
description: The updated external stock change reason
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update stock change reason
tags:
- Stocks Configuration (Inventory)
x-badges:
- color: red
label: ALPHA
/api/facilities:
get:
description: ''
operationId: getAllFacilities
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: Reference to the status you want to get the corresponding facilities
explode: true
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: number of facilities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query facilities with the given tenantFacilityId
in: query
name: tenantFacilityId
required: false
schema:
type: string
- description: query facilities orderBy
in: query
name: orderBy
required: false
schema:
$ref: '#/components/schemas/FacilityOrderBy'
- description: Filters the facilities by type
explode: true
in: query
name: type
required: false
schema:
items:
$ref: '#/components/schemas/FacilityType'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedFacilities'
description: Facilities are found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List facilities
tags:
- Facilities (Core)
post:
description: ''
operationId: addFacility
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ManagedFacilityForCreation'
- $ref: '#/components/schemas/SupplierForCreation'
description: Representation that describes the facility
required: true
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ManagedFacility'
- $ref: '#/components/schemas/Supplier'
description: >-
The facility was successfully created. The Location header contains
the URL of the facility.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create facility
tags:
- Facilities (Core)
/api/facilities/{facilityId}:
delete:
description: ''
operationId: deleteFacility
parameters:
- description: >-
ID of facility you want to delete. Also accepts tenantFacilityId in
urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: cascading deletion without pre condition check
in: query
name: forceDeletion
required: false
schema:
default: false
type: boolean
responses:
'200':
description: Facility was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: Delete facility
tags:
- Facilities (Core)
get:
description: ''
operationId: getFacility
parameters:
- description: >-
ID of facility you want to get. Also accepts tenantFacilityId in urn
format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ManagedFacility'
- $ref: '#/components/schemas/Supplier'
description: >-
Facility was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: Get facility
tags:
- Facilities (Core)
patch:
description: ''
operationId: patchFacility
parameters:
- description: >-
ID of facility you want to patch. Also accepts tenantFacilityId in
urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/FacilityPatchActions'
- $ref: '#/components/schemas/ManagedFacilityForModification'
- $ref: '#/components/schemas/SupplierForModification'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ManagedFacility'
- $ref: '#/components/schemas/Supplier'
description: >-
Facility was found & patch-set has been applied. The patched
facility is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
summary: Update facility
tags:
- Facilities (Core)
put:
operationId: replaceFacility
parameters:
- description: >-
ID of facility you want to replace. Also accepts tenantFacilityId in
urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ManagedFacilityForReplacement'
- $ref: '#/components/schemas/SupplierForReplacement'
discriminator:
propertyName: type
mapping:
MANAGED_FACILITY: '#/components/schemas/ManagedFacilityForReplacement'
SUPPLIER: '#/components/schemas/SupplierForReplacement'
required: true
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ManagedFacility'
- $ref: '#/components/schemas/Supplier'
description: Facility was replaced. The replaced facility is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
summary: Update facility
tags:
- Facilities (Core)
/api/facilities/{facilityId}/actions:
post:
operationId: facilityAction
parameters:
- description: >-
Reference to the facility you want to call the action for. Also
accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedFacility'
description: Updated Facility in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call facility action
tags:
- Facilities (Core)
/api/facilities/{facilityId}/carriers:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
List all carrier connections configured for the given facility
operationId: listFacilityCarriers
parameters:
- in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
carriers:
items:
properties:
deliveryType:
type: string
id:
type: string
key:
type: string
name:
type: string
status:
type: string
version:
type: number
required:
- id
- key
- status
- version
type: object
type: array
total:
description: Total number of carrier connections
type: number
required:
- total
- carriers
type: object
description: Listing returned 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
summary: List facility carrier connections
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
/api/facilities/{facilityId}/carriers/{carrierRef}:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
the details for a carrier related to the facility with the given ID
operationId: getFacilityCarrier
parameters:
- in: path
name: facilityId
required: true
schema:
type: string
- in: path
name: carrierRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnection'
description: >-
Carrier to facility connections was found & you were allowed to
access it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get facility carrier connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Create a connection of a configured carrier to the facility with given
ID
operationId: createCarrierToFacility
parameters:
- in: path
name: facilityId
required: true
schema:
type: string
- in: path
name: carrierRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnectionForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnection'
description: Creation was successful.
'400':
content:
application/json:
schema:
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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Create facility carrier connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
put:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Connect a configured carrier to the facility with given ID
operationId: connectCarrierToFacility
parameters:
- in: path
name: facilityId
required: true
schema:
type: string
- in: path
name: carrierRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnectionForModification'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnection'
description: Modification was successful.
'400':
content:
application/json:
schema:
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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update facility carrier connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
/api/facilities/{facilityId}/carriers/prioritization:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Calculate prioritized list of recommended carriers for the given
facility and input parameters
operationId: calculateBestCarrier
parameters:
- in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierPriorityCalculationRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierPriorityResult'
description: Calculated carrier prioritization result.
'400':
content:
application/json:
schema:
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
summary: Calculate best carriers
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
/api/facilities/{facilityId}/configurations/inventory:
get:
deprecated: false
description: Get the Inventory Configuration for a specific Facility.
operationId: getInventoryFacilityConfigurations
parameters:
- description: >-
ID of the facility you want to get the config for. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}) for the
path parameter facilityId.
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryFacilityConfiguration'
description: Requested Inventory Facility Configuration
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get facility inventory config
tags:
- Stocks Configuration (Inventory)
patch:
deprecated: false
description: >-
This endpoint allows you to update the inventory configuration for a
specific facility. It is used to set or modify the inventory management
settings at the facility level.
operationId: upsertInventoryFacilityConfigurations
parameters:
- description: >-
ID of the facility you want to set the config to. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}) for the
path parameter facilityId.
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryFacilityConfigurationForPatch'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryFacilityConfiguration'
description: Requested Inventory Facility Configuration
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update facility inventory config
tags:
- Stocks Configuration (Inventory)
/api/facilities/{facilityId}/configurations/stock:
get:
operationId: getFacilityStockConfiguration
parameters:
- description: >-
ID of facility you want to retrieve the configurations for. Also
accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityStockConfiguration'
description: Configuration for stock routing was found.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No active configurations found for this facility
summary: Get facility stock config
tags:
- Stocks Configuration (Inventory)
patch:
description: ''
operationId: patchFacilityConfiguration
parameters:
- description: >-
ID of facility you want to update the stock configuration for. Also
accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfigurationPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityStockConfiguration'
description: >-
Facility was found & patch-set has been applied. The patched
facility configuration is in the body.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility Configuration not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
summary: Update facility stock config
tags:
- Stocks Configuration (Inventory)
/api/facilities/{facilityId}/connections:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
the details for all connections related to the facility with the given
ID.
operationId: getFacilityConnections
parameters:
- description: ID of facility you want to get connections
in: path
name: facilityId
required: true
schema:
type: string
- description: The targetFacilityRef of the connection
in: query
name: targetFacilityRef
required: false
schema:
type: string
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InterFacilityConnections'
description: >-
Facility connections was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List facility connections
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Create a connections for a supplier facility with given ID.
operationId: createConnectionToFacility
parameters:
- description: ID of facility you want to create a connection for
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: >-
#/components/schemas/InterFacilityConnectionToSupplierForCreation
- $ref: >-
#/components/schemas/InterFacilityConnectionToManagedFacilityForCreation
- $ref: >-
#/components/schemas/InterFacilityConnectionToCustomerForCreation
discriminator:
propertyName: type
mapping:
CUSTOMER: >-
#/components/schemas/InterFacilityConnectionToCustomerForCreation
MANAGED_FACILITY: >-
#/components/schemas/InterFacilityConnectionToManagedFacilityForCreation
SUPPLIER: >-
#/components/schemas/InterFacilityConnectionToSupplierForCreation
description: Representation that the connection
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InterFacilityConnection'
description: Creation was successful.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create facility connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
/api/facilities/{facilityId}/connections/{connectionId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Delete the connection for facility with the given ID
operationId: deleteFacilityConnection
parameters:
- description: ID of facility you want to delete a connection
in: path
name: facilityId
required: true
schema:
type: string
- description: The ID of the connection you want to delete
in: path
name: connectionId
required: true
schema:
type: string
responses:
'200':
description: Deletion was successful
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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 for the facility and the provided id
summary: Delete facility connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
the details for a facility connection related to the facility with the
given ID.
operationId: getFacilityConnection
parameters:
- description: ID of facility you want to get connections
in: path
name: facilityId
required: true
schema:
type: string
- description: >-
The ID that describes the connection of this facility to the its
connections
in: path
name: connectionId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InterFacilityConnection'
description: >-
Facility connections was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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 for this facility referenced by the provided
connectionId
summary: Get facility connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Update the given connection for a facility
operationId: updateFacilityConnection
parameters:
- description: ID of facility you want to get
in: path
name: facilityId
required: true
schema:
type: string
- description: The referenced connection ID
in: path
name: connectionId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: >-
#/components/schemas/InterFacilityConnectionToSupplierForUpdate
- $ref: >-
#/components/schemas/InterFacilityConnectionToManagedFacilityForUpdate
- $ref: >-
#/components/schemas/InterFacilityConnectionToCustomerForUpdate
discriminator:
propertyName: type
mapping:
CUSTOMER: >-
#/components/schemas/InterFacilityConnectionToCustomerForUpdate
MANAGED_FACILITY: >-
#/components/schemas/InterFacilityConnectionToManagedFacilityForUpdate
SUPPLIER: >-
#/components/schemas/InterFacilityConnectionToSupplierForUpdate
description: Representation that describes the facility
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InterFacilityConnection'
description: Modification was successful.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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 with this facility referenced by the provided
cnnectionId.
summary: Update facility connection
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
/api/facilities/{facilityId}/customservices:
get:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getFacilityCustomServiceConnections
parameters:
- description: >-
ID of facility. Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
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
summary: List facility custom services
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
/api/facilities/{facilityId}/customservices/{customServiceId}:
delete:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: deleteFacilityCustomServiceConnection
parameters:
- description: >-
ID of facility. Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
description: The 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
summary: Delete facility custom service
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
get:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getFacilityCustomService
parameters:
- description: >-
ID of facility. Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnection'
description: 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
summary: Get facility custom service
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
patch:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: updateFacilityCustomServiceConnction
parameters:
- description: >-
ID of facility. Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnectionForUpdate'
description: Desired custom service connection to create/update
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnection'
description: The 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
summary: Update facility custom service
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
post:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createFacilityCustomServiceConnection
parameters:
- description: >-
ID of facility. Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnectionForCreation'
description: Desired custom service connection to create/update
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnection'
description: The 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
summary: Create facility custom service
tags:
- Custom Services (Core)
x-badges:
- color: red
label: ALPHA
/api/facilities/{facilityId}/listings:
delete:
description: ''
operationId: deleteListingsOfFacility
parameters:
- description: >-
ID of facility you want to delete all listings of. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
description: Facility listings were found and successfully deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Delete listings
tags:
- Listings (Core)
get:
description: ''
operationId: getFacilityListing
parameters:
- description: >-
ID of facility you want to get listing for. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of facilities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Array of tenantArticleIds
explode: false
in: query
name: tenantArticleIds
required: false
schema:
items:
type: string
maxItems: 500
type: array
- description: limit results to this scannableCode
in: query
name: scannableCode
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedListings'
description: >-
Facility was found & you were allowed to access it. The results are
in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: List listings
tags:
- Listings (Core)
put:
description: >-
Bulk PUT for Listings. Please note: This endpoint has legacy behaviour,
i.e. all PUTs fail if a single PUT fails.
operationId: putFacilityListing
parameters:
- description: >-
ID of facility you want to put listings for. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListingsForReplacement'
description: listings for put
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ListingBulkOperationResult'
type: array
description: >-
Facility listing was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Update listings
tags:
- Listings (Core)
/api/facilities/{facilityId}/listings/{tenantArticleId}:
delete:
description: ''
operationId: deleteFacilityListing
parameters:
- description: >-
ID of facility you want to delete a listing of. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: tenant ID of the articles listing you want to delete
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: Facility listing was found and successfully deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Delete listing
tags:
- Listings (Core)
get:
description: ''
operationId: getListing
parameters:
- description: >-
ID of facility you want to get listing. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: tenantArticleId of listing you want to get
in: path
name: tenantArticleId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the listing. If not
provided the default locale is used., for example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Listing'
description: >-
Listing is found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Listings not found
summary: Get listing
tags:
- Listings (Core)
patch:
description: ''
operationId: patchFacilityListing
parameters:
- description: >-
ID of facility you want to patch a listing of. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: tenant ID of the articles listing you want to patch
in: path
name: tenantArticleId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListingPatchActions'
description: listings for put
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Listing'
type: array
description: Facility listing was found and successfully patched
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Listing version conflict
summary: Update listing
tags:
- Listings (Core)
/api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks:
delete:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
This endpoint is deprecated. Use /api/stocks endpoints instead.
operationId: deleteFacilityListingPartialStock
parameters:
- description: >-
ID of facility from whom you want to delete the partial stock. Also
accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: >-
Facility listing was found & you were allowed to delete the partial
stock.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Delete listing partial stocks
tags:
- Listings (Core)
get:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
This endpoint is deprecated. Use /api/stocks endpoints instead.
operationId: getFacilityListingPartialStock
parameters:
- description: >-
ID of facility you want to get the partial stocks. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PartialStock'
type: array
description: >-
Facility and listing were found & you are allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility or Listing not found
summary: List listing partial stocks
tags:
- Listings (Core)
patch:
deprecated: true
description: >
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
This endpoint is deprecated. Use /api/stocks endpoints instead.
Adds new partial stocks, updates existing partial stocks and keeps
stocks that are previously present in the database.
1. If a stock exists in the patch action but not in the database it is
added.
2. If a stock exists both in the patch action and in the database it is
updated and the contents are merged.
3. If a stock exists only in the database, it is left untouched.
operationId: patchFacilityListingPartialStock
parameters:
- description: >-
ID of facility you want to patch the partial stocks. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PartialStockPatchActions'
description: Patch set
required: true
responses:
'200':
description: Facility listing was found & you were allowed to update it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Update listing partial stocks
tags:
- Listings (Core)
put:
deprecated: true
description: >
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
This endpoint is deprecated. Use /api/stocks endpoints instead.
Replaces the current partial stock object related to its listing
operationId: putFacilityListingPartialStock
parameters:
- description: >-
ID of facility you want to get listing. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PartialStocksForReplacement'
description: Patch set
required: true
responses:
'200':
description: Facility listing was found & you were allowed to update it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Update listing partial stocks
tags:
- Listings (Core)
/api/facilities/{facilityId}/stocks:
get:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Use
Inventory
Stock instead
operationId: getFacilityStocks
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/FacilityStock'
type: array
description: Stock was loaded and you were allowed to access it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List facility stocks
tags:
- Stocks (Inventory)
put:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Use
Inventory
Stock instead
operationId: bulkUpdateFacilityStock
parameters:
- in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityStockBulkOperations'
required: true
responses:
'207':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/FacilityStockBulkResult'
type: array
description: Update Result of each targeted tenantArticleId
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update facility stocks
tags:
- Stocks (Inventory)
/api/facilities/{facilityId}/storagelocations:
get:
description: ''
operationId: getFacilityStorageLocations
parameters:
- description: >-
ID of facility from which you want to get the storage locations.
Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: limit result to storage locations with scannable code
in: query
name: scannableCode
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StorageLocation'
type: array
description: >-
Facility was found & you are allowed to get the storage locations.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List facility storage locations
tags:
- Storage Locations (Inventory)
post:
description: Creates a new storage location in this facility.
operationId: postFacilityStorageLocations
parameters:
- description: ID of facility from whom you want to create the storage location
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationForCreation'
description: Patch set
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocation'
description: The storage location was successfully created.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Create facility storage location
tags:
- Storage Locations (Inventory)
/api/facilities/{facilityId}/storagelocations/{storageLocationId}:
delete:
description: ''
operationId: deleteFacilityStorageLocation
parameters:
- description: ID of facility from whom you want to delete the storage location
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the storageLocation you want to delete
in: path
name: storageLocationId
required: true
schema:
type: string
responses:
'200':
description: Storage location was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Delete facility storage location
tags:
- Storage Locations (Inventory)
get:
description: ''
operationId: getFacilityStorageLocation
parameters:
- description: >-
ID of facility from which you want to get the storage locations.
Also accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the storageLocation
in: path
name: storageLocationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StorageLocation'
type: array
description: >-
Facility was found & you are allowed to get the storage locations.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get facility storage location
tags:
- Storage Locations (Inventory)
patch:
description: >
Adds new storage locations, updates existing ones and keeps the
previously present ones in the database.
1. If a storage location exists in the patch action but not in the
database it is added.
2. If a storage location exists both in the patch action and in the
database it is updated and the contents merged.
3. If a storage location exists only in the database, it is left
untouched.
operationId: patchFacilityStorageLocation
parameters:
- description: ID of facility you want to patch the storage locations
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the storageLocation
in: path
name: storageLocationId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocation'
description: Storage location was found & you were allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update facility storage location
tags:
- Storage Locations (Inventory)
put:
description: >-
Replaces the current storage locations of this Facility with the
provided in the body.
operationId: putFacilityStorageLocation
parameters:
- description: ID of facility from whom you want to put the storage locations
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the storageLocation
in: path
name: storageLocationId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationForReplacement'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocation'
description: Storage location was found & you were allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update facility storage location
tags:
- Storage Locations (Inventory)
/api/facilities/{facilityId}/zones:
get:
description: ''
operationId: getFacilityZones
parameters:
- description: >-
ID of facility from which you want to get the zones. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Zone'
type: array
description: >-
Facility was found & you are allowed to get the zones. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List facility zones
tags:
- Storage Locations (Inventory)
post:
description: Creates a new zone in this facility.
operationId: postFacilityZone
parameters:
- description: >-
ID of facility at which you want to create the zones. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneForCreation'
description: The zone to be created
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Zone'
description: The zone was successfully created.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Create facility zone
tags:
- Storage Locations (Inventory)
/api/facilities/{facilityId}/zones/{zoneId}:
delete:
description: ''
operationId: deleteFacilityZone
parameters:
- description: >-
ID of facility from which you want to delete the zone. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the zone you want to delete
in: path
name: zoneId
required: true
schema:
type: string
responses:
'200':
description: Zone was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Delete facility zone
tags:
- Storage Locations (Inventory)
get:
description: ''
operationId: getFacilityZone
parameters:
- description: >-
ID of facility from which you want to get the zone. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the zone
in: path
name: zoneId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Zone'
type: array
description: >-
Zone was found & you are allowed to get it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get facility zone
tags:
- Storage Locations (Inventory)
put:
description: >-
Replaces the current zone of this Facility with the provided in the
body.
operationId: putFacilityZone
parameters:
- description: >-
ID of facility from which you want to put the zone. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the zone
in: path
name: zoneId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneForReplacement'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Zone'
description: Zone was found & you are allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update facility zone
tags:
- Storage Locations (Inventory)
/api/facilities/{facilityRef}/configurations/notifications:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Returns the notification center facility configuration.
operationId: getNotificationCenterFacilityConfig
parameters:
- in: path
name: facilityRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: >-
The notification center facility configuration was successfully
returned.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get facility notification config
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Update the notification center facility configuration.
operationId: upsertNotificationCenterFacilityConfig
parameters:
- in: path
name: facilityRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
- allOf:
- $ref: '#/components/schemas/NotificationCenterConfigForCreation'
not:
required:
- version
type: object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: Notification center facility configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: Notification center facility configuration was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Update facility notification config
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
/api/facilities/{facilityRef}/configurations/notifications/actions:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Executes an action to manipulate the notification center facility
configuration.
operationId: executeNotificationCenterFacilityConfigAction
parameters:
- in: path
name: facilityRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AddChannelAction'
- $ref: '#/components/schemas/UpdateChannelByIdAction'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
description: >-
Notification center facility configuration action was successfully
executed.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Call facility notification action
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
/api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}:
delete:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Delete the notification facility channel.
operationId: deleteNotificationCenterFacilityConfigChannel
parameters:
- in: path
name: facilityRef
required: true
schema:
type: string
- in: path
name: channelId
required: true
schema:
type: string
- in: query
name: version
required: true
schema:
type: number
responses:
'200':
description: >-
Notification center facility config channel was successfully
deleted.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Delete facility notification channel
tags:
- Notification Center Configuration (Core)
x-badges:
- color: red
label: ALPHA
/api/facilities/{facilityRef}/discounts:
get:
description: ''
operationId: getDiscountsForFacility
parameters:
- description: >-
ID of the facility you want to get the discounts for. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityRef
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of facilities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/FacilityDiscountPaginatedResult'
description: >-
The discounts were successfully retrieved. The result is in the
body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: List facility discounts
tags:
- Facilities (Core)
post:
description: ''
operationId: addDiscountToFacility
parameters:
- description: >-
ID of the facility you want to add the discount to. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityDiscountForCreation'
description: Representation that describes the discount
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityDiscount'
description: >-
The discount was successfully created. The Location header contains
the URL of the discount.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: Create facility discount
tags:
- Facilities (Core)
/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}:
delete:
description: ''
operationId: deleteDiscountForFacility
parameters:
- description: >-
ID of the facility you want to delete the discount from. Also
accepts tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityRef
required: true
schema:
type: string
- description: ID of the discount you want to delete
in: path
name: facilityDiscountRef
required: true
schema:
type: string
responses:
'200':
description: The discount was successfully deleted. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility or discount not found
summary: Delete facility discount
tags:
- Facilities (Core)
get:
description: ''
operationId: getDiscountForFacility
parameters:
- description: >-
ID of the facility you want to get the discount for. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityRef
required: true
schema:
type: string
- description: ID of the discount you want to get
in: path
name: facilityDiscountRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityDiscount'
description: The discount was successfully retrieved. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility or discount not found
summary: Get facility discount
tags:
- Facilities (Core)
patch:
description: ''
operationId: updateDiscountForFacility
parameters:
- description: >-
ID of the facility you want to update the discount for. Also accepts
tenantFacilityId in urn format (e.g.
urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
in: path
name: facilityRef
required: true
schema:
type: string
- description: ID of the discount you want to update
in: path
name: facilityDiscountRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityDiscountForUpdate'
description: Representation that describes the discount
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityDiscount'
description: The discount was successfully updated. The result is in the body.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility or discount not found
summary: Update facility discount
tags:
- Facilities (Core)
/api/facilities/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Facility
operationId: searchFacility
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilitySearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List facilities (search)
tags:
- Facilities (Core)
x-badges:
- color: orange
label: BETA
/api/facilitygroups:
get:
description: ''
operationId: getAllFacilityGroups
parameters:
- description: Returns all entries that were created after the entry with this ID.
in: query
name: startAfterId
required: false
schema:
type: string
- description: Specifies the number of facility groups to return.
in: query
name: size
required: false
schema:
default: 25
maximum: 100
type: integer
- description: Filters facility groups by the given tenant facility group ID.
in: query
name: tenantFacilityGroupId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroups'
description: The facility groups that were found based on the given filters.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The user is not authenticated or not allowed to operate against this
API instance.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The user is not authorized to access this API instance.
summary: List facility groups
tags:
- Facility Groups (Core)
post:
description: ''
operationId: addFacilityGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroupForCreation'
description: >-
Representation of a facility group, including relevant details such as
ID, name, description, and associated data.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroup'
description: The facility group was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. Please refer to the response for more details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The user is not authenticated or not allowed to operate against this
API instance.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The user is not authorized to access this API instance.
summary: Create facility group
tags:
- Facility Groups (Core)
/api/facilitygroups/{facilityGroupId}:
delete:
description: ''
operationId: deleteFacilityGroup
parameters:
- description: The ID of the facility to be deleted.
in: path
name: facilityGroupId
required: true
schema:
type: string
responses:
'200':
description: Facility group was found and deleted.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The user is not authenticated or not allowed to operate against this
API instance.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The user is not authorized to access this API instance.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility group not found.
summary: Delete facility group
tags:
- Facility Groups (Core)
get:
description: ''
operationId: getFacilityGroup
parameters:
- description: The ID of the requested facility group.
in: path
name: facilityGroupId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroup'
description: Facility group was found. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The user is not authenticated or not allowed to operate against this
API instance.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The user is not authorized to access this API instance.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility group not found.
summary: Get facility group
tags:
- Facility Groups (Core)
patch:
operationId: replaceFacilityGroup
parameters:
- description: The ID of the facility group to update.
in: path
name: facilityGroupId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroupForUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroup'
description: >-
Facility group was replaced. The replaced facility group is in the
body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The user is not authenticated or not allowed to operate against this
API instance.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The user is not authorized to access this API instance.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility group not found.
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility group version conflict.
summary: Update facility group
tags:
- Facility Groups (Core)
/api/facilitygroups/{facilityGroupId}/actions:
post:
operationId: facilityGroupAction
parameters:
- description: Reference to the facility group you want to call the action for.
in: path
name: facilityGroupId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroupActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroup'
description: Updated facility group in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call facility group action
tags:
- Facility Groups (Core)
/api/facilitygroups/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for FacilityGroup
operationId: searchFacilityGroup
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroupSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityGroupPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List facility groups (search)
tags:
- Facility Groups (Core)
x-badges:
- color: orange
label: BETA
/api/features:
get:
description: ''
operationId: getFeatures
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Feature'
description: The available feature for all active modules
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List features
tags:
- Features (Infrastructure)
/api/features/{featureName}:
get:
description: ''
operationId: getFeature
parameters:
- description: Name of the feature requested
in: path
name: featureName
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
description: The requested feature
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get feature
tags:
- Features (Infrastructure)
patch:
description: ''
operationId: patchFeature
parameters:
- description: Name of the feature requested
in: path
name: featureName
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturePatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
description: >-
Module was found & patch-set has been applied. The patched entity is
in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update feature
tags:
- Features (Infrastructure)
/api/fulfillability:
post:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
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
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
summary: Create fulfillability
tags:
- Checkout Options (DOMS)
/api/fulfillability/clickandcollect:
post:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
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
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
summary: Create click and collect fulfillability
tags:
- Checkout Options (DOMS)
/api/fulfillability/shipfromstore:
post:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
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
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
summary: Create ship from store fulfillability
tags:
- Checkout Options (DOMS)
/api/handovercontainers:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
all Handover Container respecting the given filter
operationId: getHandoverContainer
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:
items:
type: string
type: array
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
summary: List handover container
tags:
- Handovers (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Create new Handover Container
operationId: createHandoverContainer
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
summary: Create handover container
tags:
- Handovers (Operations)
x-badges:
- color: orange
label: BETA
/api/handovercontainers/{handoverContainerId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Delete handover container
operationId: deleteHandoverContainerById
parameters:
- description: id of the handover container
in: path
name: handoverContainerId
required: true
schema:
type: string
responses:
'200':
description: HandoverContainer successfully deleted.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Delete handover container
tags:
- Handovers (Operations)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
handover container
operationId: getHandoverContainerById
parameters:
- description: id of the handover container
in: path
name: handoverContainerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverContainer'
description: HandoverContainer matching the given id.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get handover container
tags:
- Handovers (Operations)
x-badges:
- color: orange
label: BETA
/api/handovercontainers/{handoverContainerId}/stack:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
handover container stack
operationId: getStackForHandoverContainer
parameters:
- description: id of the handover container
in: path
name: handoverContainerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Stack'
description: Stack for the given handoverContainer matching the given id.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get handover container stack
tags:
- Handovers (Operations)
x-badges:
- color: orange
label: BETA
/api/handoverjobs:
get:
description: ''
operationId: getAllHandoverjobs
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: This query can be used to find handoverjobs for a referenced pickjob
in: query
name: pickJobRef
required: false
schema:
type: string
- description: >-
This query can be used to find handoverjobs for a referenced
shipment
in: query
name: shipmentRef
required: false
schema:
type: string
- description: Reference the assigned user on this entity - id or username
in: query
name: assignedUser
required: false
schema:
type: string
- description: >-
Reference to the facility you want to get the corresponding
handoverJobs
in: query
name: facilityRef
required: false
schema:
type: string
- description: >-
Reference to the status you want to get the corresponding
handoverJobs
explode: true
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the carriers you want to get the corresponding
handoverJobs
in: query
name: carrierRefs
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the channel you want to get the corresponding
handoverJobs
in: query
name: channel
required: false
schema:
type: string
- description: Parameter to filter anonymized handover jobs
in: query
name: anonymized
required: false
schema:
type: boolean
- description: >-
This query can be used to find handoverjobs with the given
tenantOrderId
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: Perform full text search over all searchable attributes
in: query
name: searchTerm
required: false
schema:
type: string
- description: Start date range for pick jobs
in: query
name: startTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End date range for pick jobs
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedHandoverjobs'
description: Handoverjobs are found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List handover jobs
tags:
- Handovers (Operations)
post:
operationId: addHandoverjob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverjobForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: >-
The handoverjob was successfully created. The Location header
contains the URL of it.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create handover job
tags:
- Handovers (Operations)
/api/handoverjobs/{handoverjobId}:
get:
description: ''
operationId: getHandoverjob
parameters:
- description: ID of the handoverjob you want to get
in: path
name: handoverjobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: >-
Handoverjob was found & you were allowed to access it. The result is
in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get handover job
tags:
- Handovers (Operations)
patch:
description: ''
operationId: patchHandoverjob
parameters:
- description: ID of handoverjob you want to patch
in: path
name: handoverjobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverjobPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: >-
Handoverjob was found & patch-set has been applied. The patched
entity is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update handover job
tags:
- Handovers (Operations)
/api/handoverjobs/{handoverJobId}/actions:
post:
operationId: handoverJobAction
parameters:
- description: Reference to the handover job you want to call the action for
in: path
name: handoverJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: Updated Handover job in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call handover job action
tags:
- Handovers (Operations)
/api/handoverjobs/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for HandoverJob
operationId: searchHandoverJob
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List handover job (search)
tags:
- Handovers (Operations)
x-badges:
- color: orange
label: BETA
/api/health:
get:
description: ''
operationId: healthCheck
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResult'
description: Result of all tested dependencies for their health status
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Health check
tags:
- Health (Infrastructure)
/api/inboundprocesses:
get:
deprecated: false
description: ''
operationId: getInboundProcesses
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: query
name: sort
required: false
schema:
enum:
- ORIGIN_NAME_ASC
- REQUESTED_DATE_ASC
- LAST_MODIFIED_ASC
- ORIGIN_NAME_DESC
- REQUESTED_DATE_DESC
- LAST_MODIFIED_DESC
type: string
- in: query
name: facilityRef
required: false
schema:
items:
type: string
type: array
- in: query
name: scannableCode
required: false
schema:
type: string
- explode: false
in: query
name: status
required: false
schema:
items:
enum:
- OPEN
- PARTIAL_DELIVERY
- ON_HOLD
- CLOSED
type: string
type: array
- description: >
Matches partial values; The queries terms and therefore the result
set of the query can change in the future:
- tenantInboundProcessId
- scannableCodes
- receipts.receivedItems.tenantArticleId
- purchaseOrder.requestedItems.tenantArticleId
- purchaseOrder.supplier.name
- values of related listings
- listing.title
- listing.scannableCodes
in: query
name: searchTerm
required: false
schema:
type: string
- description: >
Only matches complete values; The queries terms and therefore the
result set of the query can change in the future:
- tenantInboundProcessId
- scannableCodes
- receipts.receivedItems.tenantArticleId
- purchaseOrder.requestedItems.tenantArticleId
- purchaseOrder.supplier.name
- values of related listings
- listing.title
- listing.scannableCodes
in: query
name: searchTermExact
required: false
schema:
type: string
- in: query
name: purchaseOrder_cancelled
required: false
schema:
type: boolean
- explode: false
in: query
name: receipt_status
required: false
schema:
items:
enum:
- OPEN
- IN_PROGRESS
- FINISHED
type: string
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPaginatedResult'
description: Paginated result containing the matching Inbound Process entities
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List inbound processes
tags:
- Inbound (Inventory)
post:
deprecated: false
description: ''
operationId: createInboundProcess
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessForCreation'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcess'
description: Created Inbound Process entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create inbound process
tags:
- Inbound (Inventory)
/api/inboundprocesses/{inboundProcessId}:
delete:
deprecated: false
description: ''
operationId: deleteInboundProcess
parameters:
- in: path
name: inboundProcessId
required: true
schema:
type: string
responses:
'200':
description: Inbound Process successfully deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Delete inbound process
tags:
- Inbound (Inventory)
get:
deprecated: false
description: ''
operationId: getInboundProcess
parameters:
- in: path
name: inboundProcessId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcess'
description: Requested Inbound Process entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get inbound process
tags:
- Inbound (Inventory)
patch:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: Patch InboundProcess
parameters:
- in: path
name: inboundProcessId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessForPatch'
required: true
responses:
'200':
description: Inbound Process successfully patched
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update inbound process
tags:
- Inbound (Inventory)
x-badges:
- color: orange
label: BETA
/api/inboundprocesses/{inboundProcessId}/purchaseorder:
put:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates or updates the specific purchase order of an existing inbound
process.
operationId: upsertInboundProcessPurchaseOrder
parameters:
- in: path
name: inboundProcessId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPurchaseOrderForUpsert'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPurchaseOrder'
description: Purchase order successfully updated on inbound process
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPurchaseOrder'
description: Purchase order successfully created on inbound process
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update purchase order
tags:
- Inbound (Inventory)
x-badges:
- color: orange
label: BETA
/api/inboundprocesses/{inboundProcessId}/receipts:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Adds a receipt to an inbound process.
operationId: addReceiptToInboundProcess
parameters:
- in: path
name: inboundProcessId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceipt'
description: Receipt was added to the inbound process
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create inbound process receipt
tags:
- Inbound (Inventory)
x-badges:
- color: orange
label: BETA
/api/inboundprocesses/attachments:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createAttachment
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundAttachmentForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundAttachment'
description: Created attachment
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create attachment
tags:
- Inbound (Inventory)
x-badges:
- color: red
label: ALPHA
/api/inboundprocesses/attachments/{attachmentId}/signedurl:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getSignedAttachmentUrl
parameters:
- in: path
name: attachmentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
description: Signed url
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get signed attachment url
tags:
- Inbound (Inventory)
x-badges:
- color: red
label: ALPHA
/api/inboundprocesses/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for InboundProcess
operationId: searchInboundProcess
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List inbound processes (search)
tags:
- Inbound (Inventory)
x-badges:
- color: orange
label: BETA
/api/inboundreceiptjobs:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getInboundReceiptJobs
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: query
name: facilityRef
required: false
schema:
items:
type: string
type: array
- explode: false
in: query
name: status
required: false
schema:
items:
enum:
- OPEN
- PARTIAL_DELIVERY
- ON_HOLD
- CLOSED
type: string
type: array
- in: query
name: searchTerm
required: false
schema:
minLength: 1
type: string
- in: query
name: searchTermExact
required: false
schema:
minLength: 1
type: string
- in: query
name: fromDate
required: false
schema:
format: date-time
type: string
- in: query
name: toDate
required: false
schema:
format: date-time
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptJobPaginatedResult'
description: Paginated Inbound Receipt Jobs
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List inbound receipt jobs
tags:
- Inbound (Inventory)
x-badges:
- color: orange
label: BETA
/api/inboundreceiptjobs/{inboundEntryId}:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getInboundReceiptJob
parameters:
- in: path
name: inboundEntryId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptJob'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get inbound receipt job
tags:
- Inbound (Inventory)
x-badges:
- color: orange
label: BETA
/api/inventory/stocks/summaries:
get:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
This endpoint is deprecated. Please use /api/stocks/summaries instead.
operationId: getStockSummariesDeprecated
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- description: >-
The stockSummaries.article.tenantArticleId value should be used for
pagination.
in: query
name: startAfterId
required: false
schema:
type: string
- explode: false
in: query
name: facilityServiceTypes
required: false
schema:
items:
enum:
- SHIP_FROM_STORE
- PICKUP
type: string
type: array
- explode: false
in: query
name: facilityStatus
required: false
schema:
items:
enum:
- ONLINE
- SUSPENDED
- OFFLINE
type: string
type: array
- explode: true
in: query
name: facilityRefs
required: false
schema:
items:
type: string
type: array
- in: query
name: allowStale
required: false
schema:
type: boolean
- explode: true
in: query
name: tenantArticleIds
required: false
schema:
items:
type: string
type: array
- description: >-
Returns stock summaries using adaptive batching to reduce latency
spikes, as a consequence response time will have a more consistent
upper bound but page size may be reduced below the maximum - This
overrides `size` argument.
in: query
name: maxPageSize
required: false
schema:
maximum: 100
minimum: 1
type: number
- description: >-
The channels to included under "channelAdjusted" in the stock
summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
unallocated stock."
explode: true
in: query
name: channelRefs
required: false
schema:
items:
type: string
maxItems: 50
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockSummaries'
description: >-
Stock summaries was loaded & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stock summaries
tags:
- Stocks (Inventory)
/api/itemreturnjobs:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the item return jobs matching the given parameters.
operationId: getItemReturnJobs
parameters:
- description: facility to filter the results
in: query
name: facilityId
required: false
schema:
type: string
- description: scannableCodes of the item return job to filter the results
in: query
name: itemReturnJobScannableCodes
required: false
schema:
items:
type: string
type: array
- description: scannableCodes of the item return to filter the results
in: query
name: itemReturnScannableCodes
required: false
schema:
items:
type: string
type: array
- description: ItemReturnJobStatus to filter the results
in: query
name: itemReturnJobStatus
required: false
schema:
items:
type: string
type: array
- description: ItemReturnStatus of an included ItemReturn to filter the results
in: query
name: itemReturnStatus
required: false
schema:
items:
type: string
type: array
- description: Term by which to search through the fields
in: query
name: searchTerm
required: false
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: show anonymized entities or not
in: query
name: anonymized
required: false
schema:
default: false
type: boolean
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
summary: List item return jobs
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates a new item return job.
operationId: createItemReturnJob
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
summary: Create item return job
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns an item return job with the provided id.
operationId: getItemReturnJob
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
summary: Get item return job
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/actions:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Applies an action to an Item Return Job. Check
ItemReturnJobActionsParameters for available actions.
operationId: updateItemReturnJob
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
summary: Call item return job action
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/itemreturns:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the item returns for a given item return job.
operationId: getItemReturns
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
summary: List item returns
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Create a new item return for an item return job
operationId: createItemReturn
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
summary: Create item return
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Delete an item return from an item return job
operationId: deleteItemReturn
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
summary: Delete item return
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns a specific item return for a given item return job.
operationId: getItemReturn
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
summary: Get item return
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Applies an action to an Item Return. Check ItemReturnActionsParameters
for available actions.
operationId: itemReturnActions
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
summary: Call item return action
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/parcels:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all parcels for an itemReturn.
operationId: createItemReturnParcel
parameters:
- description: itemReturnJobId
in: path
name: itemReturnJobId
required: true
schema:
type: string
- description: id of the itemReturn to create a parcel for
in: path
name: itemReturnId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelForCreation'
description: Payload of the parcel you want to create
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: Create a parcel for an itemReturn
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Create item return parcel
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems:
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Replace returned line items of an item return of an item return job.
operationId: replaceReturnedLineItems
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
summary: Update returned line items
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedlineitems/{returnedLineItemId}:
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Patch for a ItemReturn LineItem. This is used to update the returned
line item.
operationId: updateItemReturnLineItem
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
summary: Update returned line item
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/itemreturns:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the item returns matching the given parameters.
operationId: findItemReturns
parameters:
- description: >-
Search term you want to get the corresponding item returns. Search
will be performed on multiple fields, including return id, tenant
order id, customer name, tenant article ids, artile titles
in: query
name: searchTerm
required: false
schema:
type: string
- description: facilities to filter the results
in: query
name: facilityRefs
required: false
schema:
items:
type: string
type: array
- description: ItemReturnStatus of an included ItemReturn to filter the results
in: query
name: itemReturnStatus
required: false
schema:
items:
type: string
type: array
- description: >-
ItemReturnLineItemStatus of an included itemReturnLineItem to filter
the results
in: query
name: itemReturnLineItemStatus
required: false
schema:
items:
type: string
type: array
- 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: show anonymized entities or not
in: query
name: anonymized
required: false
schema:
default: false
type: boolean
- description: sorting for the results
in: query
name: orderBy
required: false
schema:
type: string
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
summary: Get item returns
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
/api/linkedservicejobs:
get:
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:
items:
type: string
type: array
- description: >-
Reference to the statuses you want to get the corresponding linked
service jobs
in: query
name: status
required: false
schema:
items:
type: string
type: array
- 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:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End target date range for linked service jobs
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: >-
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
- description: >-
Reference to the username you want to get the corresponding
linkedServiceJobs for
in: query
name: modifiedByUsername
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobsResult'
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
summary: List linked service jobs
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/linkedservicejobs/{linkedServiceJobsId}:
get:
operationId: getLinkedServiceJobsById
parameters:
- description: ID of LinkedServiceJobs you want to get
in: path
name: linkedServiceJobsId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobs'
description: LinkedServiceJobs 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
summary: Get linked service jobs
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks:
post:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Add
a ServiceJobLink to a LinkedServiceJob on root level.
operationId: addServiceJobLink
parameters:
- description: ID of LinkedServiceJobs you want to alter
in: path
name: linkedServiceJobsId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobLinkForAdding'
description: Desired ServiceJobLink to add
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobs'
description: The ServiceJobLink was successfully added to the LinkedServiceJobs.
'400':
content:
application/json:
schema:
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
summary: Create service job link
tags:
- Services (Operations)
x-badges:
- color: red
label: ALPHA
/api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId}:
post:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Add
a ServiceJobLink to a ServiceJobLink inside the LinkedServiceJob.
operationId: addNestedServiceJobLink
parameters:
- description: ID of LinkedServiceJobs you want to alter
in: path
name: linkedServiceJobsId
required: true
schema:
type: string
- description: >-
ID of ServiceJobLink you want to add the new ServiceJobLink
underneath
in: path
name: serviceJobLinkId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobLinkForAdding'
description: Desired ServiceJobLink to add
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobs'
description: >-
The ServiceJobLink was successfully added nested inside the
LinkedServiceJobs.
'400':
content:
application/json:
schema:
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
summary: Create service job link
tags:
- Services (Operations)
x-badges:
- color: red
label: ALPHA
/api/linkedservicejobs/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for LinkedServiceJobs
operationId: searchLinkedServiceJobs
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobsSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobsPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List linked service jobs (search)
tags:
- Services (Operations)
x-badges:
- color: orange
label: BETA
/api/listings:
put:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Bulk upsert listings independently of their facility
operationId: bulkUpsertListings
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListingBulkUpsertPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListingBulkUpsertResponse'
description: Result of the bulk upsert operation
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Update listings
tags:
- Listings (Core)
x-badges:
- color: red
label: ALPHA
/api/listings/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Listing
operationId: searchListing
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListingSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListingPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List listings (search)
tags:
- Listings (Core)
x-badges:
- color: orange
label: BETA
/api/loadunits:
delete:
operationId: deleteLoadUnits
parameters:
- description: Reference to the pickJob of which you want to delete the loadUnits
in: query
name: pickJobRef
required: false
schema:
type: string
- description: Load unit ids
explode: true
in: query
name: id
required: false
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnits'
description: Load units are successfully deleted.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: LoadUnits could not be removed due to failing conditions
summary: Delete load units
tags:
- Picking (Operations)
get:
operationId: getAllLoadUnits
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of loadUnits to show
in: query
name: size
required: false
schema:
default: 25
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List load units
tags:
- Picking (Operations)
post:
operationId: addLoadUnit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitsForCreation'
description: Representation that describes the unit load
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnits'
description: Load units are successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create load units
tags:
- Picking (Operations)
/api/loadunits/{loadUnitId}:
delete:
operationId: deleteLoadUnit
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Delete load unit
tags:
- Picking (Operations)
get:
operationId: getLoadUnitByID
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get load unit
tags:
- Picking (Operations)
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
LoadUnitPatchActions: Deprecated - For future usage please use the
/actions endpoints mentioned in the corresponding PatchActions LoadUnit:
Partial Patch on this entity.
operationId: patchLoadUnitByID
parameters:
- in: path
name: loadUnitId
required: true
schema:
type: string
- 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
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/LoadUnitPatchActions'
- $ref: '#/components/schemas/LoadUnit'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnit'
description: The found load unit.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update load unit
tags:
- Picking (Operations)
x-badges:
- color: orange
label: BETA
/api/loadunits/{loadUnitId}/actions:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Applies actions to a load unit. Check LoadUnitActionsParameter for
available actions.
operationId: updateLoadUnit
parameters:
- description: id of the load unit
in: path
name: loadUnitId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnit'
description: Updated entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Call load unit action
tags:
- Picking (Operations)
x-badges:
- color: orange
label: BETA
/api/loadunits/{loadUnitId}/stack:
get:
operationId: getStackForLoadUnit
parameters:
- in: path
name: loadUnitId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Stack'
description: The found stack for this load unit.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get load unit stack
tags:
- Picking (Operations)
/api/loadunittypes:
get:
deprecated: true
operationId: getLoadUnitTypes
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: List load unit types
tags:
- Picking (Operations)
post:
deprecated: true
operationId: createLoadUnitTypes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitTypeForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully created resource.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create load unit type
tags:
- Picking (Operations)
/api/loadunittypes/{loadUnitTypeId}:
get:
deprecated: true
operationId: getLoadUnitTypeByID
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get load unit type
tags:
- Picking (Operations)
patch:
deprecated: true
operationId: updateLoadUnitType
parameters:
- in: path
name: loadUnitTypeId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitTypePatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully updated load unit type.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update load unit type
tags:
- Picking (Operations)
/api/loadunittypes/{loadUnitTypeId}/icon:
put:
deprecated: true
operationId: uploadLoadUnitTypeIcon
parameters:
- in: path
name: loadUnitTypeId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NamedFile'
description: Base64 encoded icon to upload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully updated load unit type icon.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully created load unit type icon.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update load unit type icon
tags:
- Picking (Operations)
/api/measurementunits:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getAllMeasurementUnits
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of measurementUnits to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: key of the measurementUnit
in: query
name: key
required: false
schema:
type: string
- description: >-
Provide the localized names for the measurementUnit. If not provided
the default locale is used., for example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnits'
description: The found measurementUnit.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: List measurement units
tags:
- Measurement Units (Core)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: createMeasurementUnit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnitForCreation'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnit'
description: Successfully created the measurementUnit.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Create measurement unit
tags:
- Measurement Units (Core)
x-badges:
- color: orange
label: BETA
/api/measurementunits/{measurementUnitId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: deleteMeasurementUnit
parameters:
- in: path
name: measurementUnitId
required: true
schema:
type: string
responses:
'200':
description: Successfully deleted the measurementUnit.
'401':
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Delete measurement unit
tags:
- Measurement Units (Core)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getMeasurementUnitByID
parameters:
- in: path
name: measurementUnitId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnit'
description: The found measurementUnit.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get measurement unit
tags:
- Measurement Units (Core)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: updateMeasurementUnit
parameters:
- in: path
name: measurementUnitId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnitForCreation'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnit'
description: Successfully updated the measurementUnit.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update measurement unit
tags:
- Measurement Units (Core)
x-badges:
- color: orange
label: BETA
/api/operativecontainertypes:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all operativeContainerTypes that match the given query
parameters.
operationId: getOperativeContainerTypes
parameters:
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
maximum: 500
minimum: 1
type: integer
- 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
summary: List operative container types
tags:
- Operative Container (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates a new operativeContainerType.
operationId: createOperativeContainerType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeContainerTypeForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeContainerType'
description: Successfully created resource.
'400':
content:
application/json:
schema:
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
summary: Create operative container type
tags:
- Operative Container (Operations)
x-badges:
- color: orange
label: BETA
/api/operativecontainertypes/{operativeContainerTypeId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the operativeContainerType with the given ID.
operationId: getOperativeContainerTypeById
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
summary: Get operative container type
tags:
- Operative Container (Operations)
x-badges:
- color: orange
label: BETA
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Updates the operativeContainerType with the given ID.
operationId: updateOperativeContainerTypeById
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
summary: Update operative container type
tags:
- Operative Container (Operations)
x-badges:
- color: orange
label: BETA
/api/operativecontainertypes/{operativeContainerTypeId}/icon:
put:
operationId: uploadOperativeContainerTypeIcon
parameters:
- in: path
name: operativeContainerTypeId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NamedFile'
description: Base64 encoded icon to upload
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeContainerType'
description: Successfully updated operative container type icon.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeContainerType'
description: Successfully created operative container type icon.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update operative container type icon
tags:
- Operative Container (Operations)
/api/operativeprocesses:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
all operative processes
operationId: getOperativeProcesses
parameters:
- description: facility to filter the results
in: query
name: facilityId
required: true
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
maximum: 500
minimum: 1
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeProcessPaginatedResult'
description: All operative processes matching the given parameters
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: List operative processes
tags:
- Operative Process (Operations)
x-badges:
- color: red
label: ALPHA
/api/operativeprocesses/{operativeProcessId}:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
the operative processes for a specific id
operationId: getOperativeProcessById
parameters:
- in: path
name: operativeProcessId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeProcess'
description: Found operativeProcess by given ID
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get operative process
tags:
- Operative Process (Operations)
x-badges:
- color: red
label: ALPHA
/api/orders:
get:
description: ''
operationId: getAllOrders
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: filter orders by tenantOrderId
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: filter orders by consumerId
in: query
name: consumerId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedOrders'
description: Orders are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List orders
tags:
- Orders (DOMS)
post:
description: ''
operationId: addOrder
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderForCreation'
description: Order object supplied by your shop instance.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: >-
The order was successfully created. The Location header contains the
URL of the order.
'400':
content:
application/json:
schema:
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
summary: Create order
tags:
- Orders (DOMS)
/api/orders/{orderId}:
get:
description: ''
operationId: getOrder
parameters:
- description: ID of order you want to get
in: path
name: orderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: >-
Order was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get order
tags:
- Orders (DOMS)
patch:
description: ''
operationId: updateOrder
parameters:
- description: ID of Order you want to patch
in: path
name: orderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderForUpdate'
description: Request body for updating an order
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: >-
Order was found & patch-set has been applied. The patched entity is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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.
summary: Update order
tags:
- Orders (DOMS)
/api/orders/{orderId}/actions:
post:
operationId: orderAction
parameters:
- description: Reference to the order you want to call the action for
in: path
name: orderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: Updated Order in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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: Order not found or expired
summary: Call order action
tags:
- Orders (DOMS)
/api/orders/{orderId}/cancel:
post:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Use
/actions with "CANCEL" instead.
operationId: cancelOrder
parameters:
- description: ID of order you want to cancel
in: path
name: orderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
cancelationReasonId:
description: ID of the cancelation reason
type: string
type: object
required: false
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
summary: Cancel order
tags:
- Orders (DOMS)
/api/orders/{orderId}/orderlineitems/{orderLineItemId}/actions:
post:
operationId: orderLineItemAction
parameters:
- description: Reference to the order you want to call the action for
in: path
name: orderId
required: true
schema:
type: string
- description: Reference to the order line item you want to call the action for
in: path
name: orderLineItemId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderLineItemActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: Updated Order in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call order line item action
tags:
- Orders (DOMS)
/api/orders/search:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Search for Order
operationId: searchOrder
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List orders (search)
tags:
- Orders (DOMS)
x-badges:
- color: red
label: ALPHA
/api/packingcontainertypes:
get:
deprecated: true
description: Get all packing container types, use operative container types
operationId: getPackingContainerTypes
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: all entities after given id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PackingContainerType'
type: array
description: Found PackingContainerTypes
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List packing container types
tags:
- Packing (Operations)
post:
deprecated: true
description: Add a new packing container type, use operative container types.
operationId: addPackingContainerType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerTypeForCreation'
description: Packing type object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerType'
description: >-
The packing container type was successfully created. The Location
header contains the URL of the packing container type.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create packing container type
tags:
- Packing (Operations)
/api/packingcontainertypes/{packingContainerTypeId}:
get:
deprecated: true
description: ''
operationId: getPackingContainerType
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: id of entity
in: path
name: packingContainerTypeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerType'
description: Found PackingContainerType
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get packing container type
tags:
- Packing (Operations)
patch:
deprecated: true
description: >-
Patches a PackingContainerType with the given ID, use operative
container types
operationId: updatePackingContainerType
parameters:
- description: ID of the packingcontainertype you want to change
in: path
name: packingContainerTypeId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerTypePatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerType'
description: >-
PackingContainerType was found & patch-set has been applied. The
patched PackingContainerType is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: PackingContainerType not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: PackingContainerType version conflict
summary: Update packing container type
tags:
- Packing (Operations)
/api/packingsourcecontainers:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Listing packingSourceContainer.
operationId: getPackingSourceContainers
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: all entities after given id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
maximum: 500
type: integer
- description: filter by packJobRef
in: query
name: packJobRef
required: false
schema:
type: string
- description: filter by facilityRef
in: query
name: facilityRef
required: true
schema:
type: string
- description: filter by scannablecodes
in: query
name: codes
required: false
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PaginatedPackingSourceContainers'
type: array
description: Found Packing Source Container
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List packing source containers
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creating new packingSourceContainer.
operationId: addPackingSourceContainer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingSourceContainerForCreation'
description: Packing type object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingSourceContainer'
description: >-
The packing source container was successfully created. The Location
header contains the URL of the packing source container.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create packing source container
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
/api/packingsourcecontainers/{packingSourceContainerId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
PackingSourceContainer by ID.
operationId: getPackingSourceContainerById
parameters:
- description: ID of the packingSourceContainer
in: path
name: packingSourceContainerId
required: true
schema:
type: string
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PackingSourceContainer'
type: array
description: Found packingSourceContainer
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get packing source container
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
/api/packjobs:
get:
description: ''
operationId: getPackJobs
parameters:
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: Parameter to filter anonymized pack jobs
in: query
name: anonymized
required: false
schema:
type: boolean
- description: Reference the assigned user on this entity - id or username
in: query
name: assignedUser
required: false
schema:
type: string
- description: Reference to the status you want to get the corresponding packJobs
explode: false
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Reference to the facility you want to get the corresponding packJobs
in: query
name: facilityRef
required: false
schema:
type: string
- description: Term by which to search through the fields
in: query
name: searchTerm
required: false
schema:
type: string
- description: Reference to the channel you want to get the corresponding packJobs
in: query
name: channel
required: false
schema:
enum:
- COLLECT
- SHIPPING
type: string
- description: filter by packingsourcecontainer containing codes
in: query
name: sourceContainerCodes
required: false
schema:
items:
type: string
type: array
- description: query packjobs orderBy
in: query
name: orderBy
required: false
schema:
$ref: '#/components/schemas/PackJobOrderBy'
- description: Start date range for pack jobs
in: query
name: startTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End date range for pack jobs
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: Reference to the order you want to get the corresponding packJobs
in: query
name: orderRef
required: false
schema:
type: string
- description: Reference to the packJobs you want to get
in: query
name: packJobIds
required: false
schema:
items:
type: string
type: array
- description: Reference to the process you want to get the corresponding packJobs
in: query
name: processId
required: false
schema:
type: string
- description: >-
Reference to the pickJobRef you want to get the corresponding
packJobs
in: query
name: pickJobRef
required: false
schema:
type: string
- description: Reference to the shortId you want to get the corresponding packJobs
in: query
name: shortId
required: false
schema:
type: string
- description: >-
Reference to the articleTitle you want to get the corresponding
packJobs
in: query
name: articleTitle
required: false
schema:
type: string
- description: Start date range of the order for the corresponding pack jobs
in: query
name: startOrderDate
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End date range of the order for the corresponding pack jobs
in: query
name: endOrderDate
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: >-
Reference to the username you want to get the corresponding pack
jobs
in: query
name: modifiedByUsername
required: false
schema:
type: string
- description: >-
Reference to the tenantOrderId you want to get the corresponding
packJobs
in: query
name: tenantOrderId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobs'
description: >-
Pack jobs was loaded & you were allowed to access it. The result is
in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: List pack jobs
tags:
- Packing (Operations)
post:
description: ''
operationId: addPackJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobForCreation'
description: Pack job object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: >-
The pack job was successfully created. The Location header contains
the URL of the pack job.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create pack job
tags:
- Packing (Operations)
/api/packjobs/{packJobId}:
get:
description: ''
operationId: getPackJob
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: >-
Pack job was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack job
tags:
- Packing (Operations)
patch:
description: ''
operationId: patchPackJob
parameters:
- description: ID of the packjob you want to get
in: path
name: packJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: >-
PackJob was found & patch-set has been applied. The patched pack job
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: PackJob not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: PackJob version conflict
summary: Update pack job
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/actions:
post:
operationId: packJobAction
parameters:
- description: Reference to the pack job you want to call an action for
in: path
name: packJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: Updated PackJob in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Enitity not found
summary: Call pack job action
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/deliverynote:
get:
description: ''
operationId: getPackJobDeliveryNote
parameters:
- description: ID of the pack job for which you want to get a deliverynote
in: path
name: packJobId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The deliverynote for the given packjob
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack job delivery note
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/documenthandling:
get:
description: ''
operationId: getPackJobDocumentHandling
parameters:
- description: ID of the pack job you want to get document handling information
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentHandling'
description: >-
Pack job document handling was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack job document handling
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/returnnote:
get:
description: ''
operationId: getReturnNotesForPackJob
parameters:
- description: ID of the PackJob
in: path
name: packJobId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: Returns a return note for the packjob.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack job return note
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/targetcontainers:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all packing containers on given packJob
operationId: getAllTargetcontainers
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PackingTargetContainer'
description: >-
Entity was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: List pack job target containers
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates a new packing target container on given packJob
operationId: addTargetContainers
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainerForCreation'
description: Packing Container object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainer'
description: The packing container was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create pack job target container
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Deletes a packing target container
operationId: deletePackingTargetContainer
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to delete
in: path
name: targetcontainerId
required: true
schema:
type: string
responses:
'200':
description: Container was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Delete pack job target container
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns a packing target container with the given ID on given packJob
operationId: getTargetcontainer
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of the target container you want to get
in: path
name: targetcontainerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainer'
description: >-
Entity was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack job target container
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Patches a packing target container
operationId: patchTargetcontainer
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to patch
in: path
name: targetcontainerId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainerPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainer'
description: >-
Container was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update pack job target container
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Adds a new line item to a packing target container
operationId: addTargetcontainer
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of the container you want to add new line item to it
in: path
name: targetcontainerId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainerLineItemForCreation'
description: Packing Container line item object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainer'
description: The packing container was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Add pack job target container line item
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/deliverynote:
get:
description: ''
operationId: getPackingTargetContainerDeliveryNote
parameters:
- description: ID of the pack job for which you want to get a deliverynote
in: path
name: packJobId
required: true
schema:
type: string
- description: >-
ID of the packingTargetContainer for which you want to get a
deliverynote
in: path
name: targetcontainerId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The deliverynote for the given packingTargetContainer
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get target container delivery note
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Deletes a line item of a packing container
operationId: deleteLineItemTargetContainers
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to patch
in: path
name: targetcontainerId
required: true
schema:
type: string
- description: ID of line item you want to patch
in: path
name: lineItemId
required: true
schema:
type: string
responses:
'200':
description: LineItem was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: Delete target container line item
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Patch line item of a packing container
operationId: patchTargetContainerLineItem
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to patch
in: path
name: targetcontainerId
required: true
schema:
type: string
- description: ID of line item you want to patch
in: path
name: lineItemId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainerActionsParameter'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingTargetContainer'
description: >-
Container was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update target container line item
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/returnnote:
get:
description: ''
operationId: getReturnNotesForPackingTargetContainer
parameters:
- description: ID of the pack job for which you want to get a deliverynote
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of the PackingTargetContainer
in: path
name: targetcontainerId
required: true
schema:
type: string
- description: >-
Provide the localized values for the return note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: Returns a return note for the PackingTargetContainer.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get target container return note
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/transferlabel:
get:
description: ''
operationId: getPackingTargetContainerTransferLabel
parameters:
- description: ID of the pack job for which you want to get a transfer label
in: path
name: packJobId
required: true
schema:
type: string
- description: >-
ID of the packingTargetContainer for which you want to get a
transfer label
in: path
name: targetcontainerId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The transfer label for the given packingTargetContainer
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get target container transfer label
tags:
- Packing (Operations)
/api/packjobs/{packJobId}/transferlabel:
get:
description: ''
operationId: getPackJobTransferLabel
parameters:
- description: ID of the pack job for which you want to get a transfer label
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The transfer label for the given packjob
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pack job transfer label
tags:
- Packing (Operations)
/api/packjobs/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for PackJob
operationId: searchPackJob
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List pack jobs (search)
tags:
- Packing (Operations)
x-badges:
- color: orange
label: BETA
/api/parcels:
get:
description: ''
operationId: getAllParcels
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedParcels'
description: Parcels are found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List parcels
tags:
- Shipments (Operations)
/api/parcels/{parcelId}:
delete:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Deprecated. Use /api/parcels/{parcelId}/actions and set Parcel to
OBSOLETE.
operationId: deleteParcel
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Delete parcel
tags:
- Shipments (Operations)
get:
description: ''
operationId: getParcel
parameters:
- description: ID of the parcel you want to get
in: path
name: parcelId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: >-
Parcel was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get parcel
tags:
- Shipments (Operations)
patch:
description: ''
operationId: patchParcel
parameters:
- description: ID of the parcel you want to get
in: path
name: parcelId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: Successfully updated the parcel.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Update parcel
tags:
- Shipments (Operations)
/api/parcels/{parcelId}/actions:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Applies actions to a parcel. Check ParcelActionsParameter for
available actions.
operationId: parcelAction
parameters:
- description: Reference to the parcel you want to call an action for
in: path
name: parcelId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: Updated Parcel in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call parcel action
tags:
- Shipments (Operations)
x-badges:
- color: orange
label: BETA
/api/parcels/{parcelId}/deliverynote:
get:
operationId: getParcelDeliveryNote
parameters:
- description: ID of parcel you want to retrieve deliveryNote for
in: path
name: parcelId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf:
schema:
$ref: '#/components/schemas/DeliveryNote'
description: Get delivery note as pdf.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Parcel not found
summary: Get parcel delivery note
tags:
- Shipments (Operations)
/api/parcels/{parcelId}/labels/{labelDocument}:
get:
description: ''
operationId: getLabelForParcel
parameters:
- description: ID of the parcel you want to get a label for
in: path
name: parcelId
required: true
schema:
type: string
- description: >-
Within a parcel different labels can be created. The following types
of labels are currently supported: all.pdf, send.pdf and return.pdf
= Parcel label plus (if configured) retoure label.
in: path
name: labelDocument
required: true
schema:
$ref: '#/components/schemas/ParcelLabelTypeEnum'
responses:
'200':
content:
application/pdf: {}
description: >-
Parcel was found & you were allowed to access it. The label is in
the body.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get parcel label
tags:
- Shipments (Operations)
/api/parcels/{parcelId}/returnnote:
get:
operationId: getParcelReturnNote
parameters:
- description: ID of parcel you want to retrieve returnNote for
in: path
name: parcelId
required: true
schema:
type: string
- description: >-
Provide the localized values for the returnNote. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ReturnNote'
description: Get delivery note as pdf.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Parcel not found
summary: Get parcel return note
tags:
- Shipments (Operations)
/api/parcels/{parcelId}/transferlabel:
get:
description: ''
operationId: getParcelTransferLabel
parameters:
- description: ID of the parcel for which you want to get a transfer label
in: path
name: parcelId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The transfer label for the given parcel
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get parcel transfer label
tags:
- Shipments (Operations)
/api/parcels/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Parcel
operationId: searchParcel
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List parcels (search)
tags:
- Shipments (Operations)
x-badges:
- color: orange
label: BETA
/api/permissions:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
This endpoint returns all available permissions in the FFT platform.
operationId: getPermissions
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- description: The key of the permission to filter by
in: query
name: key
required: false
schema:
enum:
- USER_READ
- USERS_READ
- USER_WRITE
- USER_MODIFY
- CURRENT_USER_READ
- CURRENT_USER_MODIFY
- ROLE_READ
- ROLE_WRITE
- FACILITY_READ
- FACILITY_WRITE
- FACILITY_CREATE
- FACILITY_DELETE
- FACILITY_GROUP_READ
- FACILITY_GROUP_WRITE
- ORDER_READ
- ORDER_WRITE
- ORDER_FORCE_CANCEL
- ORDER_UNLOCK
- ORDER_CANCEL
- ORDER_CONSUMER_WRITE
- ORDER_CUSTOM_ATTRIBUTES_WRITE
- ORDER_LINEITEM_WRITE
- AUDIT_READ
- NOTIFICATION_READ
- NOTIFICATION_WRITE
- EXPIRIES_READ
- EXPIRIES_WRITE
- CONFIG_READ
- CONFIG_WRITE
- ROUTING_CONFIG_READ
- ROUTING_CONFIG_WRITE
- PROMISES_CONFIG_READ
- PROMISES_CONFIG_WRITE
- OIDC_PROVIDERS_CONFIG_READ
- OIDC_PROVIDERS_CONFIG_WRITE
- LOCALE_WRITE
- CARRIER_READ
- CARRIER_WRITE
- RETURN_WRITE
- RETURN_READ
- ROUTING_READ
- ROUTING_WRITE
- PARCEL_READ
- PARCEL_WRITE
- SHIPMENT_READ
- SHIPMENT_WRITE
- HANDOVERJOB_READ
- HANDOVERJOB_WRITE
- PICKJOB_READ
- PICKJOB_WRITE
- PICKJOB_REROUTE
- REMOTE_CONFIG_READ
- REMOTE_CONFIG_WRITE
- PICKRUN_READ
- PICKRUN_WRITE
- LOADUNITTYPE_READ
- LOADUNITTYPE_WRITE
- LOADUNIT_READ
- LOADUNIT_WRITE
- MEASUREMENTUNIT_READ
- MEASUREMENTUNIT_WRITE
- EVENT_READ
- SUBSCRIPTION_READ
- SUBSCRIPTION_WRITE
- SUBSTITUTE_READ
- SUBSTITUTE_WRITE
- PROCESS_READ
- PROCESS_WRITE
- PROCESS_REROUTE
- EXTERNAL_ACTIONS_READ
- EXTERNAL_ACTIONS_WRITE
- OPERATIVE_PROCESS_READ
- OPERATIVE_PROCESS_WRITE
- DELIVERYNOTE_WRITE
- PACKJOB_READ
- PACKJOB_WRITE
- PACKINGCONTAINER_TYPE_WRITE
- PACKING_SOURCE_CONTAINER_READ
- PACKING_SOURCE_CONTAINER_WRITE
- RESTOW_ITEM_READ
- RESTOW_ITEM_WRITE
- TAG_READ
- TAG_WRITE
- STOCK_READ
- STOCK_WRITE
- EXTERNAL_STOCK_CHANGE_REASONS_READ
- EXTERNAL_STOCK_CHANGE_REASONS_WRITE
- STORAGE_LOCATION_READ
- STORAGE_LOCATION_WRITE
- STOW_JOB_READ
- STOW_JOB_OPERATIVE_WRITE
- STOW_JOB_FULL_WRITE
- NOTIFICATION_CENTER_CONFIG_READ
- NOTIFICATION_CENTER_CONFIG_WRITE
- DOMS_TOOLKIT_READ
- DOMS_TOOLKIT_WRITE
- ANALYTICS_DASHBOARD_READ
- DOCUMENT_SET_READ
- DOCUMENT_SET_WRITE
- INBOUND_PROCESS_READ
- INBOUND_PROCESS_WRITE
- ADMIN_DATA_RESET
- ADMIN_MODULES_READ
- ADMIN_MODULES_WRITE
- TENANT_CONNECTOR_CONFIG_READ
- CUSTOM_SERVICE_WRITE
- CUSTOM_SERVICE_READ
- VALIDATIONS_READ
- SERVICE_JOB_READ
- SERVICE_JOB_WRITE
- LINKED_SERVICE_JOBS_READ
- LINKED_SERVICE_JOBS_WRITE
- OPERATION_STATISTICS_READ
- DOMS_STATISTICS_READ
- AVAILABILITY_CHANNEL_READ
- AVAILABILITY_CHANNEL_WRITE
- HANDOVER_CONTAINER_READ
- HANDOVER_CONTAINER_WRITE
- STACKS_READ
- STACKS_WRITE
- CATEGORY_READ
- CATEGORY_WRITE
- PERMISSION_READ
- RESERVATION_WRITE
- RESERVATION_READ
- FILTER_ENTITY_READ
- BRAND_READ
- WORKFLOW_DEFINITION_READ
- WORKFLOW_DEFINITION_WRITE
- STOCK_AVAILABILITIES_READ
- LISTING_READ
- LISTING_WRITE
- LISTING_DELETE
- PURCHASE_PRICE_READ
- ZONE_READ
- ZONE_WRITE
- SAFETY_STOCK_READ
- SAFETY_STOCK_WRITE
type: string
- description: The group of the permission to filter by
in: query
name: group
required: false
schema:
enum:
- INVENTORY
- ORDER_MANAGEMENT
- ADMIN
- CORE
- USER_MANAGEMENT
- OPERATIONS
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PermissionsResponse'
description: The Permissions
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List permissions
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/pickjobs:
get:
operationId: queryPickJobs
parameters:
- description: >-
Search term you want to get the corresponding pickjobs. Search will
be performed on multiple fields, like tenantOrderId, consumerName,
tenantArticleId and more
in: query
name: searchTerm
required: false
schema:
type: string
- description: Reference to the carrier you want to get the corresponding pickjobs
explode: false
in: query
name: carrierKeys
required: false
schema:
items:
maxItems: 100
type: string
type: array
- description: >-
Reference to the orderDate you want to get the corresponding
pickjobs
in: query
name: startOrderDate
required: false
schema:
type: string
- description: >-
Reference to the orderDate you want to get the corresponding
pickjobs
in: query
name: endOrderDate
required: false
schema:
type: string
- description: Reference to the order you want to get the corresponding pickjobs
in: query
name: orderRef
required: false
schema:
type: string
- description: Reference to the facility you want to get the corresponding pickjobs
in: query
name: facilityRef
required: false
schema:
type: string
- description: Reference the assigned user on this entity - id or username
in: query
name: assignedUser
required: false
schema:
type: string
- description: Reference to the status you want to get the corresponding pickjobs
explode: false
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Reference to the zones you want to get the corresponding pickjobs
explode: false
in: query
name: zoneRefs
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the tenantOrderId you want to get the corresponding
pickjobs
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: The channel of the pickJob you want to filter by
in: query
name: channel
required: false
schema:
enum:
- COLLECT
- SHIPPING
type: string
- description: >-
Reference to the consumer name you want to get the corresponding
pickjobs
in: query
name: consumerName
required: false
schema:
type: string
- description: Reference to the shortId you want to get the corresponding pickjobs
in: query
name: shortId
required: false
schema:
type: string
- description: >-
Reference to the articleTitle you want to get the corresponding
pickjobs
in: query
name: articleTitle
required: false
schema:
type: string
- description: >-
Reference to the anonymized you want to get the corresponding
pickjobs
in: query
name: anonymized
required: false
schema:
type: boolean
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query pickjobs orderBy
in: query
name: orderBy
required: false
schema:
type: string
- description: Start date range for pick jobs
in: query
name: startTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End date range for pick jobs
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: Reference to pickjobs
explode: false
in: query
name: pickJobRefs
required: false
schema:
items:
maxItems: 100
type: string
type: array
- description: Reference to the user ID you want to get the corresponding pickjobs
in: query
name: modifiedByUsername
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedPickJobs'
description: PickJobs were found. The results are in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List pick jobs
tags:
- Picking (Operations)
post:
description: ''
operationId: addPickJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobForCreation'
description: Pick job object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: >-
The pick job was successfully created. The Location header contains
the URL of the pickjob.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create pick job
tags:
- Picking (Operations)
/api/pickjobs/{pickJobId}:
get:
description: ''
operationId: getPickJob
parameters:
- description: ID of the pickjob you want to get
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: >-
PickJob was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pick job
tags:
- Picking (Operations)
patch:
description: ''
operationId: patchPickJob
parameters:
- description: ID of the pickjob you want to get
in: path
name: pickJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickingPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: >-
PickJob was found & patch-set has been applied. The patched pick job
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: PickJob not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: PickJob version conflict
summary: Update pick job
tags:
- Picking (Operations)
/api/pickjobs/{pickJobId}/actions:
post:
operationId: pickJobAction
parameters:
- description: Reference to the pick job you want to call an action for
in: path
name: pickJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: Updated PickJob in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call pick job action
tags:
- Picking (Operations)
/api/pickjobs/{pickJobId}/deliverynote:
get:
description: ''
operationId: getPickJobDeliveryNote
parameters:
- description: ID of the pick job for which you want to get a deliverynote
in: path
name: pickJobId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The deliverynote for the given pickjob
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pick job delivery note
tags:
- Picking (Operations)
/api/pickjobs/{pickJobId}/documenthandling:
get:
description: ''
operationId: getPickJobDocumentHandling
parameters:
- description: ID of the pick job you want to get document handling information
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentHandling'
description: >-
Pick job document handling was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pick job document handling
tags:
- Picking Configuration (Operations)
/api/pickjobs/{pickJobId}/loadunits:
get:
operationId: queryPickJobLoadUnits
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List pick job load units
tags:
- Picking (Operations)
post:
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
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingLoadUnit'
description: The load units was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create pick job load unit
tags:
- Picking (Operations)
/api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all available substitutes for a given pickLineItem.
operationId: queryPickLineItemsSubstitutes
parameters:
- description: Reference to the pick job you to get the available substitutes for
in: path
name: pickJobId
required: true
schema:
type: string
- description: >-
Reference to the pickLineItem you to get the available substitutes
for
in: path
name: pickLineItemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ResolvedSubstitutes'
description: Available substitutes for given pickLineItem
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List available line item substitutes
tags:
- Picking (Operations)
x-badges:
- color: orange
label: BETA
/api/pickjobs/{pickjobId}/returnnote:
get:
description: ''
operationId: getReturnNotesForPickjob
parameters:
- description: ID of the Pickjob
in: path
name: pickjobId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: Returns a return note for the pickjob.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pick job return note
tags:
- Picking (Operations)
/api/pickjobs/{pickJobId}/transferlabel:
get:
description: ''
operationId: getPickJobTransferLabel
parameters:
- description: ID of the pick job for which you want to get a transfer label
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The transfer label for the given pickjob
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get pick job transfer label
tags:
- Picking (Operations)
/api/pickjobs/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for PickJob
operationId: searchPickJob
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List pick jobs (search)
tags:
- Picking (Operations)
x-badges:
- color: orange
label: BETA
/api/pickruns:
post:
description: ''
operationId: addPickRun
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: >-
The PickRun was successfully created. The Location header contains
the URL of it.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
summary: Create pick run
tags:
- Picking (Operations)
/api/pickruns/{pickRunId}:
get:
description: ''
operationId: getPickRun
parameters:
- description: id of pickRun
in: path
name: pickRunId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: PickRun is found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get pick run
tags:
- Picking (Operations)
patch:
description: ''
operationId: patchPickRun
parameters:
- description: id of pickRun
in: path
name: pickRunId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunPatchAction'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: The updated PickRun.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Version conflict
summary: Update pick run
tags:
- Picking (Operations)
/api/pickruns/{pickRunId}/actions:
post:
operationId: pickRunAction
parameters:
- description: Reference to the pick run you want to call the action for
in: path
name: pickRunId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: Updated Pick Run in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call pick run action
tags:
- Picking (Operations)
/api/pickruns/{pickRunId}/pickjobs:
patch:
description: ''
operationId: patchPickRunPickJobs
parameters:
- description: id of pickRun
in: path
name: pickRunId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunPickJobsPatchAction'
responses:
'200':
description: Pick job was successfully from pick run removed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Update pick run pick jobs
tags:
- Picking (Operations)
/api/process:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getProcesses
parameters:
- in: query
name: tenantOrderId
required: false
schema:
type: string
- in: query
name: orderRef
required: false
schema:
type: string
- in: query
name: pickJobRef
required: false
schema:
type: string
- in: query
name: shipmentRef
required: false
schema:
type: string
- in: query
name: handoverJobRef
required: false
schema:
type: string
- in: query
name: returnRef
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: Process belonging to the given parameters
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The given parameters are invalid
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get process
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
/api/processes:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getAllProcesses
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Reference to the status you want to get the corresponding processes
explode: true
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the operativeStatus you want to get the corresponding
processes
explode: true
in: query
name: operativeStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the trackingStatus you want to get the corresponding
processes
explode: true
in: query
name: trackingStatus
required: false
schema:
items:
type: string
type: array
- description: Perform full text search based on the tenantOrderId
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: Perform full text search based on the consumerId
in: query
name: consumerId
required: false
schema:
type: string
- description: >-
Return the Processes which have related pickjobs with a targettime
on or after this date
in: query
name: startTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: >-
Return the Processes which have related pickjobs with a targettime
on or before this date
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: >-
Return the Processes created on or after this date. If no start date
is specified, the default is last 30 days.
in: query
name: startDate
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: Return the Processes created on or before this date
in: query
name: endDate
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: Id's of the facilities from which you want to get the processes
explode: true
in: query
name: facilityRefs
required: false
schema:
items:
type: string
type: array
- description: >-
Id's of the active facilities based on processes from which you want
to get the processes
explode: true
in: query
name: facilityRefsWithActiveOperations
required: false
schema:
items:
type: string
type: array
- description: Consumer country codes from which you want to get the processes
explode: true
in: query
name: countries
required: false
schema:
items:
type: string
type: array
- description: Facility country codes from which you want to get the processes
explode: true
in: query
name: facilityCountries
required: false
schema:
items:
type: string
type: array
- description: Brand ids for which you want to get the processes
explode: true
in: query
name: brandRefs
required: false
schema:
items:
type: string
type: array
- description: Order delivery preferences service level
explode: true
in: query
name: serviceLevels
required: false
schema:
items:
enum:
- DELIVERY
- SAMEDAY
type: string
type: array
- description: Whether an order is click and collect or delivery
explode: true
in: query
name: serviceTypes
required: false
schema:
items:
enum:
- COLLECT
- SHIPPING
type: string
type: array
- description: >-
Reference to the orderDomainStatus you want to get the corresponding
processes
explode: true
in: query
name: orderDomainStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the routingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: routingDomainStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the pickingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: pickingDomainStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the packingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: packingDomainStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the shippingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: shippingDomainStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the handoverDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: handoverDomainStatus
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the returnDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: returnDomainStatus
required: false
schema:
items:
type: string
type: array
- description: Stickers attached to a order
explode: true
in: query
name: stickers
required: false
schema:
items:
type: string
type: array
- description: Perform full text search over all searchable attributes
in: query
name: searchTerm
required: false
schema:
type: string
- description: SortingParameter name for the query
in: query
name: sortBy
required: false
schema:
$ref: '#/components/schemas/SortParameterName'
- description: Sorting direction for the query
in: query
name: sortByDirection
required: false
schema:
$ref: '#/components/schemas/SortDirection'
- description: '@deprecated Use orderStatus instead'
in: query
name: locked
required: false
schema:
type: boolean
- description: Order status for the query
in: query
name: orderStatus
required: false
schema:
$ref: '#/components/schemas/OrderStatus'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Processes'
description: Process are found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List processes
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
/api/processes/{processId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getProcessByID
parameters:
- in: path
name: processId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: The found process.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get process
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
patch:
description: ''
operationId: patchProcess
parameters:
- description: ID of process you want to patch
in: path
name: processId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: >-
Process was found & patch-set has been applied. The patched process
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Process not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Process version conflict
summary: Update process
tags:
- Processes (Core)
/api/processes/{processId}/documents:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: addDocumentToProcess
parameters:
- in: path
name: processId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentForCreation'
description: ''
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocument'
description: The document was successfully created
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
summary: Create process document
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
/api/processes/{processId}/documents/{documentId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: readDocumentMetaInProcess
parameters:
- in: path
name: processId
required: true
schema:
type: string
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocument'
description: >-
The document meta information with given id attached to the selected
process
summary: Get process document
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
/api/processes/{processId}/documents/{documentId}/file:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: downloadDocumentInProcess
parameters:
- in: path
name: processId
required: true
schema:
type: string
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The document with given id attached to the selected process
summary: Download process file
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: updateDocumentInProcess
parameters:
- in: path
name: processId
required: true
schema:
type: string
- in: path
name: documentId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentForUpdate'
description: ''
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocument'
description: The document was successfully updated
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
summary: Update process file
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
/api/processes/{processId}/historylogs:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Return all logs for a given process.
operationId: getProcessHistoryLogs
parameters:
- in: path
name: processId
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/ProcessHistoryLogs'
description: The process logs which were found in response body
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get process history logs
tags:
- Processes (Core)
x-badges:
- color: orange
label: BETA
/api/processes/{processId}/reroute:
post:
description: ''
operationId: postProcess
parameters:
- description: ID of process you want to reroute
in: path
name: processId
required: true
schema:
type: string
- description: Version of process you want to reroute
in: query
name: version
required: true
schema:
type: number
- description: The id of the rerouteDescription
in: query
name: rerouteDescriptionId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: >-
Process was found the corresponding reroute operations have been
triggered.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Process not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Process version conflict
summary: Create process reroute
tags:
- Processes (Core)
/api/processes/retrynotroutable:
post:
description: ''
operationId: triggerRetryNotRoutable
responses:
'204':
description: >-
The retry for all not routable proceses has been succesfully
triggered
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The retry task can not be triggered due to a conflicting operation
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create retry not routable
tags:
- Processes (Core)
/api/processes/search:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Search for Process
operationId: searchProcess
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List processes (search)
tags:
- Processes (Core)
x-badges:
- color: red
label: ALPHA
/api/promises/checkoutoptions:
post:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
Evaluate a checkout options input against the DOMS.
operationId: postCheckoutOptions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsInput'
required: true
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ResponseForCNCCheckoutOptions'
- $ref: '#/components/schemas/ResponseForSFSCheckoutOptions'
description: The request could be evaluated
'400':
content:
application/json:
schema:
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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Create checkout options
tags:
- Checkout Options (DOMS)
/api/promises/checkoutoptions/collect/earliest:
post:
deprecated: false
description: Get earliest collect timepoint for a given checkoutOption
operationId: checkoutoptionCollectEarliest
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsCollectEarliestRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Get earliest collect
tags:
- Checkout Options (DOMS)
/api/promises/checkoutoptions/delivery/earliest:
post:
deprecated: false
description: Get earliest delivery timepoint for a given checkoutOption
operationId: checkoutoptionDeliveryEarliest
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsDeliveryEarliestResponse'
description: The request could be evaluated
'400':
content:
application/json:
schema:
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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Get earliest delivery
tags:
- Checkout Options (DOMS)
/api/promises/checkoutoptions/delivery/timeperiod:
post:
deprecated: false
description: ''
operationId: checkoutoptionDeliveryTimePeriod
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsDeliveryTimePeriodResponse'
description: The request could be evaluated
'400':
content:
application/json:
schema:
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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Get delivery time period
tags:
- Checkout Options (DOMS)
/api/promises/checkoutoptions/delivery/timepoint:
post:
deprecated: false
description: >-
This endpoint is to be used to get information about the possible
delivery of items.
operationId: checkoutOptionsTimepoint
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsDeliveryTimePointResponse'
description: The request could be evaluated
'400':
content:
application/json:
schema:
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
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
summary: Get delivery timepoint
tags:
- Checkout Options (DOMS)
/api/promises/deliverypromise:
post:
description: ''
operationId: postDeliveryPromise
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromiseRequest'
description: Order object supplied by your shop instance
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseForDeliveryPromise'
description: The order promise was created URL of the order promse.
'400':
content:
application/json:
schema:
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
summary: Create promise order
tags:
- Orders (DOMS)
/api/purchaseorders:
post:
deprecated: false
description: ''
operationId: createPurchaseOrder
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
description: Created Purchase Order entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create purchase order
tags:
- Inbound (Inventory)
/api/purchaseorders/{purchaseOrderId}:
get:
deprecated: false
description: ''
operationId: getPurchaseOrder
parameters:
- in: path
name: purchaseOrderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
description: Purchase Order entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get purchase order
tags:
- Inbound (Inventory)
patch:
deprecated: false
description: Partially updates a Purchase Order using a selection of fields
operationId: patchPurchaseOrder
parameters:
- in: path
name: purchaseOrderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderForPartialUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
description: Updated Purchase Order entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Updates purchase order
tags:
- Inbound (Inventory)
put:
deprecated: false
description: ''
operationId: upsertPurchaseOrder
parameters:
- in: path
name: purchaseOrderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderForUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
description: Updated/created Purchase Order entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update purchase order
tags:
- Inbound (Inventory)
/api/receipts:
post:
deprecated: false
description: ''
operationId: createReceipt
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReceiptForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
description: Created inbound receipt
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create receipt
tags:
- Inbound (Inventory)
/api/receipts/{receiptId}:
delete:
deprecated: false
description: ''
operationId: deleteReceipt
parameters:
- in: path
name: receiptId
required: true
schema:
type: string
- in: query
name: version
required: true
schema:
type: number
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete receipt
tags:
- Inbound (Inventory)
get:
deprecated: false
description: ''
operationId: getReceipt
parameters:
- in: path
name: receiptId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get receipt
tags:
- Inbound (Inventory)
patch:
deprecated: false
description: ''
operationId: patchReceipt
parameters:
- in: path
name: receiptId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptForPatch'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update receipt
tags:
- Inbound (Inventory)
put:
deprecated: false
description: ''
operationId: putReceipt
parameters:
- in: path
name: receiptId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptForUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
description: ''
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update receipt
tags:
- Inbound (Inventory)
/api/remoteconfigs:
get:
description: ''
operationId: getAllRemoteConfigurations
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:
items:
type: string
type: array
- description: userId to filter to
in: query
name: userId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfigurations'
description: Central RemoteConfiguration
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List remote configs
tags:
- Remote Configs (Core)
post:
description: ''
operationId: createRemoteConfiguration
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
summary: Create remote config
tags:
- Remote Configs (Core)
/api/remoteconfigs/{id}:
delete:
description: ''
operationId: deleteRemoteConfiguration
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
summary: Delete remote config
tags:
- Remote Configs (Core)
get:
description: ''
operationId: getRemoteConfiguration
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
summary: Get remote config
tags:
- Remote Configs (Core)
patch:
description: ''
operationId: updateRemoteConfiguration
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
summary: Update remote config
tags:
- Remote Configs (Core)
put:
description: ''
operationId: putRemoteConfiguration
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
summary: Update remote config
tags:
- Remote Configs (Core)
/api/remoteconfigs/{id}/scopes:
post:
description: ''
operationId: addRemoteConfigurationScope
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
summary: Create remote config scope
tags:
- Remote Configs (Core)
/api/remoteconfigs/{id}/scopes/{scopeId}:
delete:
description: ''
operationId: deleteScopeFromRemoteConfiguration
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
summary: Delete remote config scope
tags:
- Remote Configs (Core)
/api/reroutedescriptions:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getRerouteDescriptions
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescriptions'
description: >-
RerouteDescription were found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List reroute descriptions
tags:
- Routing Plans (DOMS)
x-badges:
- color: orange
label: BETA
post:
operationId: postRerouteDescription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescriptionForCreation'
description: The RerouteDescription
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescription'
description: >-
The RerouteDescription has been successfully created. The Location
header includes the URL of the document.
'303':
description: >-
The RerouteDescription already exists. The Location header contains
the URL of the document.
'400':
content:
application/json:
schema:
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
summary: Create reroute description
tags:
- Routing Plans (DOMS)
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: orange
label: BETA
/api/reroutedescriptions/{rerouteDescriptionId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: deleteRerouteDescription
parameters:
- description: ID of the reroute description you intend to delete
in: path
name: rerouteDescriptionId
required: true
schema:
type: string
responses:
'200':
description: >-
The reroute description was found, and you have been granted
permission to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Delete reroute description
tags:
- Routing Plans Configuration (DOMS)
x-badges:
- color: orange
label: BETA
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getRerouteDescriptionById
parameters:
- description: Id of the reroute description you wish to retrieve
in: path
name: rerouteDescriptionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescription'
description: >-
RerouteDescription was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get reroute description
tags:
- Routing Plans Configuration (DOMS)
x-badges:
- color: orange
label: BETA
put:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: putRerouteDescription
parameters:
- description: ID of the reroute description you intend to modify
in: path
name: rerouteDescriptionId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescriptionForModification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescription'
description: >-
RerouteDescription rating was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update reroute description
tags:
- Routing Plans Configuration (DOMS)
x-badges:
- color: orange
label: BETA
/api/reservations:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getPaginatedReservations
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- description: >-
The cursor to start after. The value is provided in the
`pageInfo.endCursor` field of the response.
in: query
name: after
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReservationsPaginatedResult'
description: Reservation details
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List reservations
tags:
- Reservations (Inventory)
x-badges:
- color: red
label: ALPHA
/api/reservations/{reservationId}:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getReservation
parameters:
- in: path
name: reservationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Reservation'
description: Reservation details
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get reservation
tags:
- Reservations (Inventory)
x-badges:
- color: red
label: ALPHA
/api/reservations/actions:
post:
deprecated: false
description: >
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
REMOVE_RESERVATIONS_KEEP_STOCKS: Removes reservations without
modifying stock levels.
REMOVE_RESERVATIONS_AND_REDUCE_STOCKS: Removes reservations and reduces stock levels accordingly.
operationId: performReservationActions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReservationAction'
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ReservationActionResult'
type: array
description: List of reservation removal results with stock operations
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Call reservations action
tags:
- Reservations (Inventory)
x-badges:
- color: red
label: ALPHA
/api/reservations/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Reservation
operationId: searchReservation
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReservationSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReservationPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List reservations (search)
tags:
- Reservations (Inventory)
x-badges:
- color: orange
label: BETA
/api/restowitems:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: queryRestowItems
parameters:
- description: Reference to the facility you want to get the corresponding restows
in: query
name: facilityRef
required: false
schema:
type: string
- description: Reference restowed status of the restow items
in: query
name: restowed
required: false
schema:
type: boolean
- description: Reference status of the restow items
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query orderBy
in: query
name: orderBy
required: false
schema:
$ref: '#/components/schemas/RestowItemsSortOptionsEnum'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowedItems'
description: Restow items were found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List restow items
tags:
- Restowing (Operations)
x-badges:
- color: orange
label: BETA
/api/restowitems/{restowItemId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getRestowItem
parameters:
- description: ID of the restow item you want to get
in: path
name: restowItemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItem'
description: >-
RestowItem was found & you were allowed to access it. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Get restow item
tags:
- Restowing (Operations)
x-badges:
- color: orange
label: BETA
patch:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Deprecated, please use /api/restowitems/{restowItemId}/actions
operationId: patchRestowItem
parameters:
- description: ID of the restow item you want to update
in: path
name: restowItemId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItemPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItem'
description: >-
RestowItem was found & patch-set has been applied. The patched
restow item is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update restow item
tags:
- Restowing (Operations)
x-badges:
- color: orange
label: BETA
/api/restowitems/{restowItemId}/actions:
post:
operationId: restowItemAction
parameters:
- description: Reference to the restow item you want to call an action for
in: path
name: restowItemId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItemActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItem'
description: Updated RestowItem in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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: The entity you want to call an action for was not found.
summary: Call restow item action
tags:
- Restowing (Operations)
/api/returnnotes:
post:
operationId: createReturnNote
parameters:
- description: >-
Provide the localized values for the return note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNote'
required: true
responses:
'201':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ReturnNote'
description: Successfully created the return note.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create return note
tags:
- Shipments (Operations)
/api/returns:
get:
deprecated: true
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
No
longer supported legacy return. Please use /itemreturnjobs instead.
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
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJobs'
description: Return Jobs that were found in response body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List return jobs
tags:
- Returns (Operations)
x-badges:
- color: orange
label: BETA
post:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
No
longer supported legacy return. Please use /itemreturnjobs instead.
operationId: addReturn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJobForCreation'
description: 'ReturnJob object '
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJob'
description: The return was successfully created
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create return job
tags:
- Returns (Operations)
/api/returns/{returnId}:
get:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
No
longer supported legacy return. Please use /itemreturnjobs instead.
operationId: getReturnLines
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: User not found
summary: Get return job
tags:
- Returns (Operations)
patch:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
No
longer supported legacy return. Please use /itemreturnjobs instead.
operationId: patchReturn
parameters:
- description: ID of return you want to patch
in: path
name: returnId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnPatchActions'
description: Patch set
required: true
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:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update return job
tags:
- Returns (Operations)
/api/roles:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns all existing roles, including their permissions and context
ceilings.
operationId: getAllRoles
parameters: []
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Role'
type: array
description: The requested roles.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List roles
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Creates a new custom role.
operationId: createRole
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: The created role.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create role
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/roles/{name}:
delete:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: deleteRole
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: The deleted role.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete role
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns a role requested by its name.
operationId: getRole
parameters:
- in: path
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: The requested role.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Return role
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
patch:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: patchRole
parameters:
- in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleForPatch'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: The patched role, including all the updates made.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update role
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
put:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: updateRole
parameters:
- in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleForUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: The updated role, including all the updates made.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update role
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/roles/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Role
operationId: searchRole
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoleSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RolePaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List roles (search)
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/routing/commands/reroute:
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: reRoute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteRoutingPlan'
description: >-
An object, that can contain either lists of identifiers for which a
reroute should be executed or an option to reroute every reroutable
plan.
required: true
responses:
'200':
description: Rerouting was successfully triggered
'401':
content:
'*/*':
schema:
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
summary: Trigger reroute
tags:
- Routing Plans (DOMS)
x-badges:
- color: orange
label: BETA
/api/routing/decisionlogs:
get:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getRoutingDecisionLogs
parameters:
- description: >-
Filter decision logs by only one of the following references:
processRef, orderRef, tenantOrderId, routingPlanRef or
sourcingOptionsRef.
explode: true
in: query
name: relatedRefs
required: false
schema:
additionalProperties: false
maxProperties: 1
minProperties: 1
properties:
orderRef:
type: string
processRef:
type: string
routingPlanRef:
type: string
sourcingOptionsRef:
type: string
tenantOrderId:
type: string
type: object
style: form
- description: All decision logs after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: Number of decision logs to show
in: query
name: size
required: false
schema:
default: 25
maximum: 500
minimum: 1
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingDecisionLogs'
description: >-
Decision logs were found & you were allowed to access them. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get routing decision logs
tags:
- Routing Strategy (DOMS)
x-badges:
- color: red
label: ALPHA
/api/routing/nodeconfigcategories:
get:
description: ''
operationId: getRoutingStrategyNodeConfigCategories
parameters:
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: >-
#/components/schemas/RoutingStrategyNodeConfigCategoryTransporter
description: The current list of available categories
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List category node configuration
tags:
- Routing Strategy (DOMS)
post:
description: Creates a new category for a routing strategies node config.
operationId: postRoutingStrategyNodeConfigCategory
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/RoutingStrategyNodeConfigCategoryForCreation
description: The desired category
required: true
responses:
'201':
content:
application/json:
schema:
$ref: >-
#/components/schemas/RoutingStrategyNodeConfigCategoryForResponse
description: The created routing strategy.
'400':
content:
application/json:
schema:
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
summary: Create category node configuration
tags:
- Routing Strategy (DOMS)
/api/routing/nodeconfigcategories/{categoryId}:
delete:
description: deletes the category
operationId: deleteRoutingStrategyNodeConfigCategory
parameters:
- description: Id of the category you want to delete
in: path
name: categoryId
required: true
schema:
type: string
responses:
'200':
description: The category has been deleted.
'400':
content:
application/json:
schema:
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
summary: Delete category node configuration
tags:
- Routing Strategy (DOMS)
get:
description: returns the category
operationId: getRoutingStrategyNodeConfigCategory
parameters:
- description: Id of the category you wish to retrieve
in: path
name: categoryId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: >-
#/components/schemas/RoutingStrategyNodeConfigCategoryForResponse
description: The returned category.
'400':
content:
application/json:
schema:
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
summary: Returns category node configuration
tags:
- Routing Strategy (DOMS)
put:
description: Updates a category
operationId: putRoutingStrategyNodeConfigCategory
parameters:
- description: Id of the category you wish to update
in: path
name: categoryId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
#/components/schemas/RoutingStrategyNodeConfigCategoryForModification
description: The updated category
required: true
responses:
'200':
content:
application/json:
schema:
$ref: >-
#/components/schemas/RoutingStrategyNodeConfigCategoryForResponse
description: The updated category.
'400':
content:
application/json:
schema:
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
summary: Updates category node configuration
tags:
- Routing Strategy (DOMS)
/api/routing/sourcingoptions:
post:
operationId: createSourcingOptionsRequest
parameters:
- description: >-
This part of the API is in Alpha status. For details please check
the api-release-life-cycle documentation.
respond with mock
in: query
name: returnMockResponse
required: false
schema:
type: boolean
x-badges:
- color: red
label: ALPHA
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SourcingOptionsRequest'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SourcingOptionsResponse'
application/xml:
schema:
$ref: '#/components/schemas/SourcingOptionsResponse'
description: Sourcing Option successfully created
'400':
description: Validation exception
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create sourcing option
tags:
- Sourcing Options (DOMS)
/api/routing/sourcingoptions/{sourcingOptionsRequestId}:
get:
operationId: getSourcingOption
parameters:
- description: Id of the sourcing option request
in: path
name: sourcingOptionsRequestId
required: true
schema:
type: string
- description: >-
This part of the API is in Alpha status. For details please check
the api-release-life-cycle documentation.
respond with mock
in: query
name: returnMockResponse
required: false
schema:
type: boolean
x-badges:
- color: red
label: ALPHA
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SourcingOptionsResponse'
application/xml:
schema:
$ref: '#/components/schemas/SourcingOptionsResponse'
description: Sourcing Options successfully created
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Get sourcing option
tags:
- Sourcing Options (DOMS)
/api/routing/strategies:
get:
description: ''
operationId: getRoutingStrategies
parameters:
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategyTransporter'
description: The current list of available routing strategies
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List routing strategies
tags:
- Routing Strategy (DOMS)
post:
description: Creates a new revision of the routing strategy.
operationId: postRoutingStrategy
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategyForCreation'
description: The desired routing strategy
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategy'
description: The created routing strategy.
'400':
content:
application/json:
schema:
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
summary: Create routing strategy
tags:
- Routing Strategy (DOMS)
/api/routing/strategies/{strategyId}:
get:
description: Returns the routing strategy.
operationId: getRoutingStrategy
parameters:
- description: Id of the routing strategy you wish to retrieve
in: path
name: strategyId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategy'
description: The returned routing strategy.
'400':
content:
application/json:
schema:
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
summary: Get routing strategy
tags:
- Routing Strategy (DOMS)
put:
description: Updates a routing strategy
operationId: putRoutingStrategy
parameters:
- description: Id of the routing strategy you wish to update
in: path
name: strategyId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategyForModification'
description: The updated routing strategy
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategy'
description: The updated routing strategy.
'400':
content:
application/json:
schema:
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
summary: Update routing strategy
tags:
- Routing Strategy (DOMS)
/api/routing/strategies/{strategyId}/actions:
post:
description: Performs an action on a routing strategy.
operationId: actionsRoutingStrategy
parameters:
- description: Id of the routing strategy
in: path
name: strategyId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategyActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategy'
description: The updated routing strategy.
'400':
content:
application/json:
schema:
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
summary: Call routing strategy action
tags:
- Routing Strategy (DOMS)
/api/routing/strategies/{strategyId}/evaluation:
post:
description: Evaluates a routing strategy against a given order
operationId: evaluateRoutingStrategy
parameters:
- description: Id of the routing strategy
in: path
name: strategyId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderForCreation'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategyEvaluationResult'
description: The result of the evaluation of the routing strategy.
'400':
content:
application/json:
schema:
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: The routing strategy does not exist
summary: Evaluate routing strategy
tags:
- Routing Strategy (DOMS)
/api/routing/strategies/{strategyId}/nodes/{nodeId}/evaluation:
post:
description: Evaluates a routing strategy node and return the path.
operationId: evaluateRoutingStrategyNode
parameters:
- description: Id of the routing strategy
in: path
name: strategyId
required: true
schema:
type: string
- description: Id of the node
in: path
name: nodeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingStrategyEvaluationResult'
description: The result of the evaluation of this routing strategy node.
'400':
content:
application/json:
schema:
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: The routing strategy node does not exist
summary: Evaluate routing strategy node
tags:
- Routing Strategy (DOMS)
/api/routingplans:
get:
description: ''
operationId: getRoutingPlanBaseOnOrderRef
parameters:
- description: >-
Reference to the order you want to get the corresponding routing
plan.
in: query
name: orderRef
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlans'
description: >-
Routing plan was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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.
summary: List routing plans
tags:
- Routing Plans (DOMS)
/api/routingplans/{routingplanId}:
get:
description: ''
operationId: getRoutingPlan
parameters:
- description: ID of the routing plan want to get
in: path
name: routingplanId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlan'
description: >-
Routing plan was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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.
summary: Get routing plan
tags:
- Routing Plans (DOMS)
patch:
description: ''
operationId: patchRoutingPlan
parameters:
- description: ID of routing plan you want to patch
in: path
name: routingplanId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlanPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlan'
description: >-
Routing plan was found & patch-set has been applied. The patched
entity is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: Update routing plan
tags:
- Routing Plans (DOMS)
/api/routingplans/{routingplanId}/decisionlogs/{routingRun}:
get:
description: ''
operationId: getDecisionlog
parameters:
- description: ID of the routing plan you want to get it's decision log
in: path
name: routingplanId
required: true
schema:
type: string
- description: ID of the decision log you want to get
in: path
name: routingRun
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionLog'
description: Decision log was found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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
summary: List routing plan decision log
tags:
- Routing Plans (DOMS)
/api/routingplans/search:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Search for RoutingPlan
operationId: searchRoutingPlan
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlanSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlanPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List routing plans (search)
tags:
- Routing Plans (DOMS)
x-badges:
- color: red
label: ALPHA
/api/routingplansgraph:
get:
description: ''
operationId: getRoutingPlansGraphBaseOnProcessRef
parameters:
- description: >-
Reference to the process you want to get the corresponding routing
plans graph.
in: query
name: processRef
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlansGraph'
description: >-
Routing plans graph was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this 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.
summary: List routing plans graphs
tags:
- Routing Plans (DOMS)
/api/safetystocks:
get:
deprecated: false
description: ''
operationId: getSafetyStocks
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: query
name: tenantArticleId
required: false
schema:
type: string
- in: query
name: facilityRef
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SafetyStocksPaginatedResult'
description: Available Safety Stocks
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List safety stocks
tags:
- Stocks (Inventory)
put:
deprecated: false
description: ''
operationId: bulkUpdateSafetyStock
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SafetyStockBulkOperations'
required: true
responses:
'207':
content:
application/json:
schema:
$ref: '#/components/schemas/SafetyStockBulkOperationResult'
description: Result of the bulk operations
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update safety stocks
tags:
- Stocks (Inventory)
/api/safetystocks/{safetyStockId}:
delete:
deprecated: false
description: ''
operationId: deleteSafetyStock
parameters:
- in: path
name: safetyStockId
required: true
schema:
type: string
responses:
'200':
description: Result of the bulk operations
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete safety stock
tags:
- Stocks (Inventory)
/api/scopedcapabilities:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getCapabilities
parameters:
- description: id of the facility
in: query
name: facilityId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ScopedCapability'
description: All ScopedCapabilities which are at least inactive
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: List scoped capabilities
tags:
- Features (Infrastructure)
x-badges:
- color: orange
label: BETA
/api/servicejobs:
get:
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 the assigned user on this entity - id or username
in: query
name: assignedUser
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:
items:
type: string
type: array
- 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:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End target date range for service jobs
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: >-
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
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
summary: List service jobs
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
post:
operationId: createServiceJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobForCreation'
description: Desired service job to create
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJob'
description: The service job was successfully created.
'400':
content:
application/json:
schema:
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
summary: Create service job
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/servicejobs/{serviceJobId}:
get:
operationId: getServiceJob
parameters:
- description: ID of service job you want to get
in: path
name: serviceJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJob'
description: Service Job 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
summary: Get service job
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/servicejobs/{serviceJobId}/actions:
post:
operationId: updateServiceJob
parameters:
- description: ID of service job you want to update
in: path
name: serviceJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobActionsParameter'
description: Desired change to a service job
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJob'
description: The service job was successfully updated.
'400':
content:
application/json:
schema:
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
summary: Call service job action
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/servicejobs/{serviceJobId}/servicedata:
get:
operationId: getServiceData
parameters:
- description: ID of service job referenced by the service data you want to get
in: path
name: serviceJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceData'
description: Service Data 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
summary: Get service data
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/servicejobs/{serviceJobId}/servicedata/actions:
post:
operationId: updateServiceData
parameters:
- description: ID of service job referenced by the service data you want to update
in: path
name: serviceJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceDataActionsParameter'
description: Desired change to service data
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceData'
description: The service data was successfully updated.
'400':
content:
application/json:
schema:
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
summary: Call service data action
tags:
- Services (Operations)
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: red
label: ALPHA
/api/shipments:
get:
description: ''
operationId: getAllShipments
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: This query can be used to find shipments for a referenced pickjob
in: query
name: pickJobRef
required: false
schema:
type: string
- description: >-
This query can be used to find shipments belonging to the referenced
facility
in: query
name: facilityRef
required: false
schema:
type: string
- description: This query can be used to find shipments for a referenced carrier
in: query
name: carrierRef
required: false
schema:
type: string
- description: >-
This query can be used to find shipments with the given
tenantOrderId
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: Find shipments with one the the given carriers
explode: false
in: query
name: carrierKeys
required: false
schema:
items:
type: string
type: array
- description: Find shipments in one of the given status
explode: false
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Find shipments with parcels in one of the given status
explode: false
in: query
name: parcelStatus
required: false
schema:
items:
type: string
type: array
- description: Start date range for shipments
in: query
name: startTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: End date range for shipments
in: query
name: endTargetTime
required: false
schema:
example: 2020-02-03T08:45:50.525Z
format: date-time
type: string
- description: Parameter to filter anonymized shipments
in: query
name: anonymized
required: false
schema:
type: boolean
- description: >-
Fulltext search in shipment's tenantOrderId, shortId,
parcels.carrierTrackingNumber, lineItems.article.tenantArticleId,
lineItems.article.title, invoiceAddress, targetAddress and
customerName
in: query
name: searchTerm
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedShipments'
description: Shipments are found.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List shipments
tags:
- Shipments (Operations)
post:
operationId: addShipment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentForCreation'
description: Shipment object supplied by your picking app
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: >-
The Shipment was successfully created. The Location header contains
the URL of the Shipment.
'303':
description: >-
The Shipment already exists. The Location header contains the URL of
the Shipment.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create shipment
tags:
- Shipments (Operations)
/api/shipments/{shipmentId}:
get:
description: ''
operationId: getShipment
parameters:
- description: ID of Shipment you want to get
in: path
name: shipmentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: >-
Shipment was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Shipment not found
summary: Get shipment
tags:
- Shipments (Operations)
patch:
description: ''
operationId: patchShipment
parameters:
- description: ID of shipment you want to patch
in: path
name: shipmentId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentPatchActions'
description: Patch set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: >-
Shipment was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
summary: Update shipment
tags:
- Shipments (Operations)
/api/shipments/{shipmentId}/actions:
post:
operationId: shipmentActions
parameters:
- description: Reference to the shipment you want to call an action for
in: path
name: shipmentId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: Updated Shipment in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Call shipment action
tags:
- Shipments (Operations)
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
x-badges:
- color: orange
label: BETA
/api/shipments/{shipmentId}/deliverynote:
get:
operationId: getShipmentDeliveryNote
parameters:
- description: ID of shipment you want to retrieve delivery note for
in: path
name: shipmentId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf:
schema:
$ref: '#/components/schemas/DeliveryNote'
description: Get delivery note as pdf.
'401':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ApiError'
description: Shipment not found
summary: Get shipment delivery note
tags:
- Shipments (Operations)
/api/shipments/{shipmentId}/parcels:
post:
description: ''
operationId: addParcel
parameters:
- description: ID of shipment you want to create parcel for
in: path
name: shipmentId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelForCreation'
description: Payload of the parcel you want to create
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: >-
The Parcel was successfully created. The Location header contains
the URL of the Shipment.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Parcel could not be processed due to failing conditions
summary: Create shipment parcel
tags:
- Shipments (Operations)
/api/shipments/parcels:
post:
description: >-
This endpoints directly creates a parcel. If no ShipmentRef was
provided, a shipment will be created and linked to this parcel
operationId: directCreateParcel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelForDirectCreation'
description: Representation that describes the parcel you want to create
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: Parcel was successfully created
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create parcel
tags:
- Shipments (Operations)
/api/shipments/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Shipment
operationId: searchShipment
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List shipments (search)
tags:
- Shipments (Operations)
x-badges:
- color: orange
label: BETA
/api/stacks:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
all Stacks respecting the given filter
operationId: getStacks
parameters:
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: facilities to filter the results
in: query
name: facilityRefs
required: false
schema:
items:
type: string
type: array
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
summary: Get stacks
tags:
- Stacks (Operations)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Create new Stack
operationId: createStack
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
summary: Create stack
tags:
- Stacks (Operations)
x-badges:
- color: orange
label: BETA
/api/stacks/{stackId}:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Get
Stack respecting the given id
operationId: getStackById
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
summary: Get stack
tags:
- Stacks (Operations)
x-badges:
- color: orange
label: BETA
/api/status:
get:
description: Returns the platform status.
operationId: status
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
description: The status result
summary: Get status
tags:
- Health (Infrastructure)
/api/stocks:
get:
deprecated: false
description: ''
operationId: getStocks
parameters:
- in: query
name: facilityRef
required: false
schema:
type: string
- in: query
name: tenantFacilityId
required: false
schema:
type: string
- in: query
name: tenantArticleId
required: false
schema:
items:
type: string
maxItems: 500
type: array
- in: query
name: locationRef
required: false
schema:
items:
type: string
maxItems: 500
type: array
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockPaginatedResult'
description: Stocks
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stocks
tags:
- Stocks (Inventory)
post:
deprecated: false
description: ''
operationId: createStock
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Stock'
description: Stock was created.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Create stock
tags:
- Stocks (Inventory)
put:
deprecated: false
description: Update and create many stocks at once
operationId: upsertStocks
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StocksForUpsert'
required: true
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StockUpsertOperationResult'
type: array
description: Stock upsert result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update stocks
tags:
- Stocks (Inventory)
/api/stocks/{stockId}:
delete:
deprecated: false
description: ''
operationId: deleteStock
parameters:
- in: path
name: stockId
required: true
schema:
type: string
responses:
'200':
description: Stock was deleted.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Delete stock
tags:
- Stocks (Inventory)
get:
deprecated: false
description: ''
operationId: getStock
parameters:
- in: path
name: stockId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Stock'
description: Stock
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get stock
tags:
- Stocks (Inventory)
put:
deprecated: false
description: ''
operationId: updateStock
parameters:
- in: path
name: stockId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/StockForUpdate'
- not:
required:
- version
properties:
locationRef:
nullable: true
type: string
value:
format: int32
minimum: 0
type: integer
required:
- value
type: object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Stock'
description: Stock
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Update stock
tags:
- Stocks (Inventory)
/api/stocks/{stockId}/locationrecommendations:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Get
the Storage Location recommendations for a specific Stock.
operationId: getStorageLocationRecommendations
parameters:
- in: path
name: stockId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StorageLocationRecommendation'
type: array
description: >-
List of Storage Locations sorted by the stock sum ascending. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Get stock recommendations
tags:
- Stocks (Inventory)
x-badges:
- color: red
label: ALPHA
/api/stocks/actions:
post:
deprecated: false
description: ''
operationId: performStocksActions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockAction'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockActionResult'
description: Stock action result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: Call stock action
tags:
- Stocks (Inventory)
/api/stocks/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Stock
operationId: searchStock
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stocks (search)
tags:
- Stocks (Inventory)
x-badges:
- color: orange
label: BETA
/api/stocks/summaries:
get:
deprecated: false
description: Get the accumulated Stock for each Article
operationId: getStockSummaries
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- description: >-
The stockSummaries.article.tenantArticleId value should be used for
pagination.
in: query
name: startAfterId
required: false
schema:
type: string
- explode: false
in: query
name: facilityServiceTypes
required: false
schema:
items:
enum:
- SHIP_FROM_STORE
- PICKUP
type: string
type: array
- explode: false
in: query
name: facilityStatus
required: false
schema:
items:
enum:
- ONLINE
- SUSPENDED
- OFFLINE
type: string
type: array
- explode: true
in: query
name: facilityRefs
required: false
schema:
items:
type: string
type: array
- in: query
name: allowStale
required: false
schema:
type: boolean
- explode: true
in: query
name: tenantArticleIds
required: false
schema:
items:
type: string
type: array
- description: >-
Returns stock summaries using adaptive batching to reduce latency
spikes, as a consequence response time will have a more consistent
upper bound but page size may be reduced below the maximum - This
overrides `size` argument.
in: query
name: maxPageSize
required: false
schema:
maximum: 100
minimum: 1
type: number
- description: >-
The channels to included under "channelAdjusted" in the stock
summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
unallocated stock."
explode: true
in: query
name: channelRefs
required: false
schema:
items:
type: string
maxItems: 50
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockSummaries'
description: >-
Stock summaries was loaded & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stock summaries
tags:
- Stocks (Inventory)
/api/storagelocations/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for StorageLocation
operationId: searchStorageLocation
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List storage locations (search)
tags:
- Storage Locations (Inventory)
x-badges:
- color: orange
label: BETA
/api/stowjobs:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getStowJobs
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- in: query
name: sort
required: false
schema:
enum:
- LAST_MODIFIED_ASC
- LAST_MODIFIED_DESC
type: string
- in: query
name: facilityRef
required: false
schema:
items:
type: string
type: array
- in: query
name: tenantArticleId
required: false
schema:
items:
type: string
type: array
- in: query
name: locationRef
required: false
schema:
items:
type: string
type: array
- explode: false
in: query
name: status
required: false
schema:
items:
enum:
- OPEN
- IN_PROGRESS
- CLOSED
- CANCELED
- PAUSED
type: string
type: array
- in: query
name: stockRef
required: false
schema:
items:
type: string
type: array
- in: query
name: shortId
required: false
schema:
items:
type: string
type: array
- in: query
name: priority
required: false
schema:
items:
type: number
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StowJobPaginatedResult'
description: Paginated result containing the matching Stow Job entities
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stow jobs
tags:
- Stowing (Inventory)
x-badges:
- color: red
label: ALPHA
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: createStowJob
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StowJobForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/StowJob'
description: Created Stow Job entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The syntax of the request content was correct, but it was unable to
process the contained instructions, possibly due to semantic errors.
summary: Create stow job
tags:
- Stowing (Inventory)
x-badges:
- color: red
label: ALPHA
/api/stowjobs/{stowJobId}:
get:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: getStowJob
parameters:
- in: path
name: stowJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StowJob'
description: Requested Stow Job entity
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get stow job
tags:
- Stowing (Inventory)
x-badges:
- color: red
label: ALPHA
patch:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: Patch StowJob
parameters:
- in: path
name: stowJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StowJobForPatch'
required: true
responses:
'200':
description: Stow Job successfully patched
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The syntax of the request content was correct, but it was unable to
process the contained instructions, possibly due to semantic errors.
summary: Update stow job
tags:
- Stowing (Inventory)
x-badges:
- color: red
label: ALPHA
/api/stowjobs/{stowJobId}/actions:
post:
deprecated: false
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: Post StowJob Actions
parameters:
- in: path
name: stowJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/StartStowJobAction'
- $ref: '#/components/schemas/PauseStowJobAction'
- $ref: '#/components/schemas/CancelStowJobAction'
- $ref: '#/components/schemas/ReopenStowJobAction'
- $ref: '#/components/schemas/CloseStowJobAction'
- $ref: '#/components/schemas/ModifyStowLineItemsAction'
- $ref: '#/components/schemas/StowJobReplaceAssignedUsersAction'
required: true
responses:
'200':
description: Actions successfully performed
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: A version conflict occurred.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
The syntax of the request content was correct, but it was unable to
process the contained instructions, possibly due to semantic errors.
summary: Call stow job action
tags:
- Stowing (Inventory)
x-badges:
- color: red
label: ALPHA
/api/stowjobs/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for StowJob
operationId: searchStowJob
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StowJobSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StowJobPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List stow jobs (search)
tags:
- Stowing (Inventory)
x-badges:
- color: orange
label: BETA
/api/subscriptions:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getSubscriptions
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscriptions'
description: All subscriptions.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List subscriptions
tags:
- Eventing (Core)
x-badges:
- color: orange
label: BETA
post:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Add
new Subscription. Please note: Currently it is only possible to add max.
five subscriptions per event.
operationId: addSubscription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionForCreation'
description: Representation that describes the subscription
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: Subscription is successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create subscription
tags:
- Eventing (Core)
x-badges:
- color: orange
label: BETA
/api/subscriptions/{subscriptionId}:
delete:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: deleteSubscription
parameters:
- description: ID of the subscription you want to delete
in: path
name: subscriptionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: Subscription is successfully deleted.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Delete subscription
tags:
- Eventing (Core)
x-badges:
- color: orange
label: BETA
/api/substitutes:
get:
operationId: getResultingSubstitutesForTenantArticleId
parameters:
- description: the tenantArticleId substitutes are requested for
in: query
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Substitutes'
description: >-
There are substitutes for the given tenantArticleId. The result can
be found in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: List substitutes
tags:
- Picking (Operations)
/api/substitutes/{tenantArticleId}:
delete:
description: ''
operationId: deleteSubstitutesForTenantArticleId
parameters:
- description: the tenant article ID the subsitutes should be deleted for
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: >-
The substitutes for the given tenantArticleId were successfully
deleted
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Delete substitutes
tags:
- Picking (Operations)
get:
description: Get the substitutes for a given tenant article id
operationId: getSubstitutesForTenantArticleId
parameters:
- description: ''
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Substitutes'
description: >-
The substitutes for the given tenantArticleId can be found in the
body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility not found
summary: Get substitutes
tags:
- Picking (Operations)
put:
description: ''
operationId: putSubstitutesForTenantArticleID
parameters:
- description: Tenant article ID of the article the substitutes should be set for
in: path
name: tenantArticleId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutesForUpsert'
description: substitutes to set
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Substitutes'
description: The substitutes for tenantArticleId were successfully updated
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
summary: Set substitutes
tags:
- Picking (Operations)
/api/supportedevents:
get:
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
operationId: getEvents
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SupportedEvents'
description: All supported events.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: List supported events
tags:
- Eventing (Core)
x-badges:
- color: orange
label: BETA
/api/tags:
get:
description: ''
operationId: getTags
parameters:
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedTags'
description: The current list of available tags
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: No more elements available
summary: List tags
tags:
- Tags (Core)
post:
description: ''
operationId: addTag
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagForCreation'
description: Tag object
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: The tag was successfully created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
summary: Create tag
tags:
- Tags (Core)
/api/tags/{tagRef}:
get:
description: ''
operationId: getTag
parameters:
- description: Id of the tag you want to get
in: path
name: tagRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: >-
Tag was found & you were allowed to access it. The result is in the
body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: User not found
summary: Get tag
tags:
- Tags (Core)
patch:
description: ''
operationId: putTag
parameters:
- description: Id of the tag you want to update
in: path
name: tagRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagPatchActions'
description: Tag patch action
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: >-
Tag was found & you were allowed to access it. The result is in the
body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Tag not found
summary: Update tag
tags:
- Tags (Core)
/api/tags/packing/needspacking:
post:
description: ''
operationId: getNeedsPacking
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TagReference'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/NeedsPacking'
description: >-
NeedsPacking information for this tag was found & you were allowed
to access it. The result is in the body.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Entity not found
summary: Get needs packing for tags
tags:
- Packing Configuration (Operations)
/api/users:
get:
deprecated: false
description: ''
operationId: getAllUsers
parameters:
- in: query
name: size
required: false
schema:
default: 25
maximum: 100
minimum: 1
type: number
- in: query
name: startAfterId
required: false
schema:
type: string
- description: Order the users by this field
in: query
name: orderBy
required: false
schema:
type: string
- description: Filter the users by this facility
in: query
name: facilityId
required: false
schema:
type: string
- description: >-
Include all admins in the result (only applicable if facilityId is
set)
in: query
name: includeAdminUsers
required: false
schema:
type: boolean
responses:
'200':
description: The users were successfully returned.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: List users
tags:
- User Management (Core)
post:
deprecated: false
description: ''
operationId: createUser
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserForCreation'
required: true
responses:
'201':
description: The users was successfully created.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Creates user
tags:
- User Management (Core)
/api/users/{userId}:
delete:
deprecated: false
description: ''
operationId: deleteUser
parameters:
- in: path
name: userId
required: true
schema:
type: string
responses:
'200':
description: The deleted user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete user
tags:
- User Management (Core)
get:
deprecated: false
description: ''
operationId: getUser
parameters:
- in: path
name: userId
required: true
schema:
type: string
responses:
'200':
description: The user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Return user
tags:
- User Management (Core)
patch:
deprecated: false
description: ''
operationId: changeUser
parameters:
- in: path
name: userId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserPatchActions'
required: true
responses:
'200':
description: The modified user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Update user
tags:
- User Management (Core)
/api/users/{userId}/assignedFacilities:
post:
deprecated: false
description: ''
operationId: assignFacility
parameters:
- in: path
name: userId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserAssignedFacilityForCreation'
required: true
responses:
'200':
description: The facilities were successfully assigned to the user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Create facility assignment
tags:
- User Management (Core)
/api/users/{userId}/assignedFacilities/{assignedFacilityId}:
delete:
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
operationId: deleteAssignedFacility
parameters:
- in: path
name: userId
required: true
schema:
type: string
- in: path
name: assignedFacilityId
required: true
schema:
type: string
responses:
'201':
description: The facility was successfully removed from the user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Delete facility assignment
tags:
- User Management (Core)
/api/users/{userId}/permissions:
get:
deprecated: false
description: Returns the roles of a user.
operationId: getUserRoles
parameters:
- in: path
name: userId
required: true
schema:
type: string
responses:
'200':
description: The roles of the user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The requested entity was not found
summary: Get user roles
tags:
- User Management (Core)
/api/users/me:
patch:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Update my own data.
operationId: updateMe
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyUserPersonalData'
required: true
responses:
'200':
description: Updating my data was successful.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
summary: Update me user
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/users/me/effectivepermissions:
get:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Returns the effective permissions of the user.
operationId: getEffectivePermissions
parameters: []
responses:
'200':
description: The effective permissions of the user.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
summary: Return effective permissions
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/users/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for User
operationId: searchUser
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserPaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List users (search)
tags:
- User Management (Core)
x-badges:
- color: orange
label: BETA
/api/validations/postalcodes:
post:
description: ''
operationId: validatePostalCode
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostalCodeValidation'
description: Branding object
required: true
responses:
'200':
description: The given postal code is valid for the given country
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The given postal code is invalid for the given country
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: The given country can't be validated
summary: Validate postal code
tags:
- Validations (Core)
/api/zones/search:
post:
deprecated: false
description: >-
This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.
Search for Zone
operationId: searchZone
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneSearchPayload'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ZonePaginatedResult'
description: Your search result
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Your user, although recognized, is not authorized to use this
summary: List zones (search)
tags:
- Storage Locations (Inventory)
x-badges:
- color: orange
label: BETA
/graphql:
get:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
Returns the GraphQL playground.
operationId: getGraphQLPlayground
responses:
'200':
description: The GraphQL playground
summary: Get GraphQL
tags:
- GraphQL (Infrastructure)
x-badges:
- color: red
label: ALPHA
post:
description: >-
This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.
operationId: executeGraphQLCommand
responses:
'200':
description: The GraphQL command was successfully executed.
'400':
description: GraphQL validation error
summary: Execute GraphQL command
tags:
- GraphQL (Infrastructure)
x-badges:
- color: red
label: ALPHA
components:
schemas:
AbortPickJob:
allOf:
- $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
deprecated: true
description: >-
This part of the API is deprecated. For details please check the api-release-life-cycle documentation.
@deprecated Use api/pickjobs/:id/actions instead
title: AbortPickJob
xml:
name: AbortPickJob
AbstractArticle:
properties:
titleLocalized:
allOf:
- $ref: '#/components/schemas/LocaleString'
description: The translations for the title of the product
customAttributes:
description: >-
Attributes that can be added to this entity. These attributes
**cannot** be used within fulfillment processes, but enable you to
attach custom data from your systems to fulfillmenttools entities.
nullable: true
type: object
imageUrl:
description: >-
A web link to a picture of this article. Please make sure that no
authentication is required to fetch the image!
type: string
tenantArticleId:
description: This is a reference to an article number
example: '4711'
type: string
title:
description: The title of the product
example: Cologne Water
type: string
weight:
description: weight value is in gram
minimum: 0
type: number
required:
- tenantArticleId
- title
title: AbstractArticle
type: object
description: AbstractArticle
AbstractCarrierCredentials:
discriminator:
propertyName: key
properties:
key:
type: string
required:
- key
type: object
xml:
name: AbstractCarrierCredentials
title: AbstractCarrierCredentials
description: AbstractCarrierCredentials
AbstractFacilityActionsParameter:
discriminator:
propertyName: name
properties:
name:
type: string
version:
description: Version of the entity to be changed
minimum: 0
type: integer
required:
- name
- version
title: AbstractFacilityActionsParameter
description: AbstractFacilityActionsParameter
AbstractFulfillabilityConstraintType:
properties:
type:
description: >-
Type of the constraint (must be supported by the fulfillmenttools
platform).
enum:
- ITEMS
example: ITEMS
type: string
value:
description: Additional parameters needed for the referenced type of constraint.
type: object
type: object
title: AbstractFulfillabilityConstraintType
description: AbstractFulfillabilityConstraintType
AbstractModificationAction:
discriminator:
propertyName: action
properties:
action:
description: ''
enum:
- AddAllowedValueToTag
- ModifyPickJob
- ModifyPickJobLastEditor
- RestartPickJob
- ResetPickJob
- CancelPickRun
- CancelHandoverjob
- AbortPickJob
- FinishPickRun
- StartPickRun
- ModifyPickLineItem
- ModifyPickRunLineItem
- ModifyPackJob
- PausePackJob
- ModifyPackLineItem
- SplitLineItemsPackJob
- ModifyFacility
- ModifyListing
- ModifyRetainedOfflineStock
- ModifyListingReactivationAfter
- ModifyUser
- ModifyShipment
- ModifyHandoverjob
- ModifyCarrier
- ModifyShortpick
- ModifyReturn
- ModifyReturnLineItem
- ModifyRoutingPlan
- ModifyFence
- ModifyRating
- ModifyTimingMode
- ModifyGlobalRoutingConfiguration
- ModifyOrderSplit
- ModifyPrioritization
- ModifyLoadUnitType
- ModifyFeature
- ModifyParcel
- ModifyParcelLoadUnit
- ModifyRestowItem
- RemovePickJobFromPickRun
- ModifyPartialStock
- AddTagsToProcess
- AssignFacilityToProcess
- UpdateGdprCleanupDateAction
- ModifyStorageLocation
- ModifyPackingContainerType
- ModifyPackingContainerTypeIcon
- ReplaceCodesInPackingTargetContainer
- ReplaceLoadUnitLineItems
- AddLineItemToPackingTargetContainer
- RemoveLineItemFromPackingTargetContainer
- UpdateLineItemOnPackingTargetContainer
- UpdatePackingTargetContainerLineItemRecordableAttributes
- ModifyCustomService
- UnlockOrder
example: