openapi: 3.0.1
info:
contact:
email: api@fulfillmenttools.com
name: fulfillmenttools
url: https://fulfillmenttools.com/
description: >-
This is the fulfillmenttools API documentation. Visit
https://docs.fulfillmenttools.com/ for first steps.
termsOfService: http://swagger.io/terms/
title: fulfillmenttools - simplifying retail complexity
version: VERSIONLESS
paths:
/api/artifacts/{platform}:
get:
parameters:
- description: Platform for which to list artifacts
in: path
name: platform
required: true
schema:
enum:
- android
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ArtifactMetadataItems'
description: All available artifacts for the selected platform
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The given platform is invalid
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Infrastructure - Artifacts
description: ''
operationId: getArtifacts
summary: Provides metadata for currently available artifacts for a platform
/api/carriers:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedCarriers'
description: The current list of available carriers
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: No more elements available
tags:
- Last Mile Integration - Carriers
description: ''
operationId: getCarriers
summary: Returns all configured CEP partners
post:
parameters:
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
description: >-
The carrier was successfully created. The Location header contains
the URL of the carrier.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Last Mile Integration - Carriers
description: ''
operationId: addCarrier
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierForCreation'
description: Carrier object
required: true
summary: Add a new carrier as a CEP partner
/api/carriers/{carrierId}:
get:
parameters:
- description: ID of the carrier you want to get
in: path
name: carrierId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
description: >-
Carrier was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: getCarrier
summary: Get a carrier with the given ID
patch:
parameters:
- description: ID of carrier you want to patch
in: path
name: carrierId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Carrier'
description: >-
Carrier was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Last Mile Integration - Carriers
description: ''
operationId: patchCarrier
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierPatchActions'
description: Patch set
required: true
summary: Patches a carrier with the given ID
/api/carriers/{carrierId}/configuration:
get:
parameters:
- description: ID of the carrier you want to get the configuration
in: path
name: carrierId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/CarrierConfiguration'
- $ref: '#/components/schemas/GlsCarrierConfiguration'
- $ref: '#/components/schemas/FedexCarrierConfiguration'
- $ref: '#/components/schemas/BringCarrierConfiguration'
- $ref: '#/components/schemas/DpdChCarrierConfiguration'
- $ref: '#/components/schemas/DhlV2CarrierConfiguration'
- $ref: '#/components/schemas/VceCarrierConfiguration'
description: >-
Carrier Configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier Configuration not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: getCarrierConfiguration
summary: Get a carrier configuration with the given ID
put:
parameters:
- description: ID of the carrier you want to update the configuration
in: path
name: carrierId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/CarrierConfiguration'
- $ref: '#/components/schemas/GlsCarrierConfiguration'
- $ref: '#/components/schemas/FedexCarrierConfiguration'
- $ref: '#/components/schemas/BringCarrierConfiguration'
- $ref: '#/components/schemas/DhlV2CarrierConfiguration'
- $ref: '#/components/schemas/VceCarrierConfiguration'
description: >-
Carrier Configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier Configuration not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: putCarrierConfiguration
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/CarrierConfiguration'
- $ref: '#/components/schemas/GlsCarrierConfiguration'
- $ref: '#/components/schemas/FedexCarrierConfiguration'
- $ref: '#/components/schemas/BringCarrierConfiguration'
- $ref: '#/components/schemas/DhlV2CarrierConfiguration'
- $ref: '#/components/schemas/VceCarrierConfiguration'
description: Carrier Configuration
required: true
summary: Update a carrier configuration with the given ID
/api/carriers/{carrierId}/configuration/countryservicemappings:
get:
parameters:
- description: ID of the carrier you want to get the countryservicemappings for
in: path
name: carrierId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CarrierCountryServiceMapping'
description: >-
Carrier's countryservicemappings found & you are allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier's countryservicemappings Configuration not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: getCarrierCountryServiceMappings
summary: Get a CarrierCountryServiceMappings for carrier with given ID
post:
parameters:
- description: ID of the carrier you want to create a countryservicemapping for
in: path
name: carrierId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMapping'
description: >-
CarrierCountryServiceMapping successfully created. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: createCarrierCountryServiceMapping
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMappingForCreation'
description: Carrier Configuration
required: true
summary: Crwate a carrierCountryServiceMapping for carrier with given ID
/api/carriers/{carrierId}/configuration/countryservicemappings/{countryServiceMappingId}:
get:
parameters:
- description: ID of the carrier you want to get a countryservicemapping for
in: path
name: carrierId
required: true
schema:
type: string
- description: ID of the countryservicemapping
in: path
name: countryServiceMappingId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMapping'
description: >-
Carrier's countryservicemapping found & you are allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier's countryservicemappings Configuration not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: getCarrierCountryServiceMapping
summary: Get a CarrierCountryServiceMappings for carrier with given ID
patch:
parameters:
- description: ID of the carrier you want to update a countryservicemapping of
in: path
name: carrierId
required: true
schema:
type: string
- description: ID of the countryservicemapping
in: path
name: countryServiceMappingId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMapping'
description: >-
CarrierCountryServiceMapping successfully updated. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier or CarrierCountryServiceMapping not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: updateCarrierCountryServiceMapping
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CarrierCountryServiceMappingForUpdate'
description: Carrier Mapping for update
required: true
summary: Update a carrierCountryServiceMapping for carrier with given ID
delete:
parameters:
- description: ID of the carrier you want to delete a countryservicemapping from
in: path
name: carrierId
required: true
schema:
type: string
- description: ID of the countryservicemapping
in: path
name: countryServiceMappingId
required: true
schema:
type: string
responses:
'200':
description: CarrierCountryServiceMapping successfully deleted.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Carrier or CarrierCountryServiceMapping not found
tags:
- Last Mile Integration - Carriers
description: ''
operationId: deleteCarrierCountryServiceMapping
summary: Delete a carrierCountryServiceMapping for carrier with given ID
/api/configurations/cutofftime:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CutoffTimeConfiguration'
description: >-
Cutoff time configuration was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Cutoff time configuration not found
tags:
- Fulfillment Operations - Picking
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getCutoffTimeConfiguration
summary: Get a tenant wide cutoff time config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CutoffTimeConfiguration'
description: Cutoff time configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Cutoff time configuration not found
tags:
- Fulfillment Operations - Picking
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putCutoffTimeConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CutoffTimeConfiguration'
required: true
summary: Update cutoff time configuration of a tenant
/api/configurations/tenant:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfiguration'
description: >-
Tenant configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Tenant configuration not found
tags:
- Core - Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getTenantConfiguration
summary: Get a tenant config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfiguration'
description: Tenant configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Tenant configuration not found
tags:
- Core - Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Upsert tenant configuration
operationId: putTenantConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConfigurationForUpsert'
required: true
summary: Update tenant configuration of a tenant
/api/configurations/deliverynote:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfiguration'
description: >-
Delivery note configuration was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Delivery note configuration not found
tags:
- Fulfillment Operations - Shipments
operationId: getDeliveryNoteConfiguration
summary: Get a tenant wide delivery configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfiguration'
description: Delivery note configuration was successfully updated
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfiguration'
description: Delivery note configuration was successfully created
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
operationId: putDeliveryNoteConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNoteConfigurationForUpsert'
required: true
summary: Update delivery note configuration of a tenant
/api/configurations/tenantconnector:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TenantConnectorConfigurations'
description: >-
Configuration was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: configuration not found
tags:
- Infrastructure - Artifacts
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getTenantConnectorConfigurations
summary: Get a tenant wide app connector configuration
/api/configurations/packing:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: Central Configuration of all packing related things
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
operationId: getPackingConfigurations
summary: Get the packing configurations
patch:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: The packing central configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: The packing central configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: ''
operationId: upsertPackingConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingConfigurations'
description: create/update packing central configuration
required: true
summary: Change the tenant wide packing central configuration
/api/configurations/handover:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverConfiguration'
description: >-
Handover configuration was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Handover
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getHandoverConfiguration
summary: Read handover configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverConfiguration'
description: The handover configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Handover
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putHandoverConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverConfiguration'
description: Desired HandoverConfiguration
required: true
summary: Change the handover configuration
/api/configurations/tags/packjob:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobTagConfiguration'
description: Packjob tag config is in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackJobTagConfiguration
summary: Read tag configuration for the specified section
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobTagConfiguration'
description: The packing configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: ''
operationId: putPackJobTagConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobTagConfiguration'
description: Desired PackJobTagConfiguration
required: true
summary: Change the tag configuration for packjobs
/api/configurations/tags/parcel:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelTagConfiguration'
description: tag config is in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Shipments
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getParcelTagConfiguration
summary: Read tag configuration for parcels
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelTagConfiguration'
description: The tag configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putParcelTagConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelTagConfigurationForUpsert'
description: Desired Tag Configuration for Parcels
required: true
summary: Change the tag configuration for Parcels
/api/configurations/tags/handoverjob:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobTagConfiguration'
description: handoverJob tag config is in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Handover
description: ''
operationId: getHandoverJobTagConfiguration
summary: Read tag configuration for handoverJobs
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobTagConfiguration'
description: The handoverjob tag configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Handover
description: ''
operationId: putHandoverTagConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobTagConfiguration'
description: Desired Tag Configuration for HandoverJobs
required: true
summary: Change the tag configuration for HandoverJobs
/api/configurations/tags/order:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTagConfiguration'
description: order tag config is in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- DOMS - Orders
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getOrderTagConfiguration
summary: Read tag configuration for orders
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTagConfiguration'
description: The order tag configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
description: ''
operationId: putOrderTagConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderTagConfiguration'
description: Desired Tag Configuration for orders
required: true
summary: Change the tag configuration for orders
/api/configurations/domain:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: Domain config could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Infrastructure - Artifacts
description: ''
operationId: getDomainConfiguration
summary: Get default authentication domain of the tenant
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: The domain configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: The domain configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Infrastructure - Artifacts
description: ''
operationId: putDomainConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainConfiguration'
description: Desired domain note configuration to create/update
required: true
summary: Change the tenant's default authentication domain configuration
/api/configurations/fulfillmentprocessbuffer:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
description: >-
Configuration was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Configuration not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getFulfillmentProcessBufferConfiguration
summary: Get a tenant fulfillment process buffer configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
description: Configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Configuration not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putFulfillmentProcessBufferConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillmentProcessBufferConfiguration'
required: true
summary: Update fulfillment process buffer configuration of a tenant
/api/configurations/capacityplanningtimeframe:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
description: >-
Configuration was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Configuration not found
tags:
- DOMS - Routing Plans
description: ''
operationId: getCapacityPlanningTimeframeConfiguration
summary: Get a tenant capacity planning timeframe configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
description: Configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Configuration not found
tags:
- DOMS - Routing Plans
description: ''
operationId: putCapacityPlanningTimeframeConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CapacityPlanningTimeframeConfiguration'
required: true
summary: Update capacity planning timeframe configuration of a tenant
/api/configurations/gdpr:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GdprConfiguration'
description: >-
Gdpr configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Gdpr configuration not found
tags:
- Core - Configuration
description: ''
operationId: getGdprConfiguration
summary: Get a tenant gdpr config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GdprConfiguration'
description: Gdpr configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Gdpr configuration not found
tags:
- Core - Configuration
description: ''
operationId: putGdprConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GdprConfiguration'
required: true
summary: Update gdpr configuration of a tenant
/api/configurations/loadunit:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: The load unit configuration can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: getLoadUnitConfiguration
summary: Get the load unit configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: The load unit configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: The load unit configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putLoadUnitConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitConfiguration'
description: Desired load unit configuration to create/update
required: true
summary: Change the tenant wide load unit configuration
/api/configurations/locale:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocaleConfiguration'
description: The locale Configuration can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Configuration
description: ''
operationId: getLocaleConfiguration
summary: Get the tenant wide default locale configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocaleConfiguration'
description: The locale Configuration was successfully set.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Configuration
description: ''
operationId: putLocaleConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LocaleConfiguration'
description: Desired default locale configuration to put
required: true
summary: Change the tenant wide default locale configuration
/api/configurations/orderrouting:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: The Order Routing Configuration can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getOrderRoutingConfiguration
summary: Get the tenant wide order routing configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: The order routing configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: The order routing configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Routing Plans
description: ''
operationId: putOrderRoutingConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderRoutingConfiguration'
description: Desired order routing configuration to create/update
required: true
summary: Change the tenant wide order routing configuration
/api/configurations/oidcproviders:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviders'
description: existing oidc providers.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Infrastructure - OIDC Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Get the available OIDC providers.
operationId: getOidcProviders
summary: Get the available OIDC providers.
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviderForCreation'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedOidcProvider'
description: Provider was updated successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Infrastructure - OIDC Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Create an OIDC provider.
operationId: createOidcProvider
summary: Create an OIDC provider.
/api/configurations/oidcproviders/{oidcProviderId}:
get:
parameters:
- description: ID of OIDC provider you want to get.
in: path
name: oidcProviderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedOidcProvider'
description: Provider was found
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Infrastructure - OIDC Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getOidcProvider
summary: Get OIDC provider by id.
put:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviderForUpdate'
parameters:
- description: ID of OIDC provider you want to update.
in: path
name: oidcProviderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OidcProviderForUpdate'
description: Provider was updated successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Infrastructure - OIDC Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Update an OIDC Provider.
operationId: updateOidcProvider
summary: Update an OIDC Provider.
delete:
parameters:
- description: ID of the OIDC provider you want to delete.
in: path
name: oidcProviderId
required: true
schema:
type: string
responses:
'200':
description: OIDC Provider was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: OIDC Provider not found
tags:
- Infrastructure - OIDC Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Delete an OIDC Provider.
operationId: deleteOidcProvider
summary: Delete an OIDC Provider.
/api/configurations/pickingtimes:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultPickingTimesConfiguration'
description: Picking Times config found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getDefaultPickingTimesConfiguration
summary: Get the current configuration for tenant wide default picking times
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultPickingTimesConfiguration'
description: The default picking times configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Configuration version conflict
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putDefaultPickingTimesConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DefaultPickingTimesConfiguration'
description: Desired default picking times configuration to create/update
required: true
summary: Change the tenant wide default picking times configuration
/api/configurations/returnnote:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfiguration'
description: Return note config could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Shipments
operationId: getReturnNoteConfiguration
summary: Get defined return notes of the tenant
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfiguration'
description: The return note configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfiguration'
description: The return note configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: putReturnNoteConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNoteConfigurationForUpsert'
description: Desired return note configuration to create/update
required: true
summary: Change the tenant wide return note configuration
/api/configurations/routing:
get:
parameters:
- description: Provide to get an older version of the configuration
in: query
name: version
schema:
type: number
- description: >-
Provide the localized names and descriptions for the routing
configuration. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingConfiguration'
description: >-
Routing configuration was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Routing configuration not found
tags:
- DOMS - Routing Plans
description: ''
operationId: getRoutingConfiguration
summary: Get a tenant routing config
patch:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingConfiguration'
description: Routing configuration was found & patch-set has been applied.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found, for more information please look at details.
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- DOMS - Routing Plans
description: >-
Important: You can only change the name and the description for fences,
ratings and prioritizations of type CUSTOM. For Fences and Ratings
provided by fulfillmenttools you can not change the fields 'name' and
'description'.
operationId: patchRoutingConfig
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingConfigurationsPatchActions'
description: Patch set
required: true
summary: Patches routing configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingConfiguration'
description: Routing configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Routing configuration not found
tags:
- DOMS - Routing Plans
description: >-
Important: You can only change the name and the description for fences,
ratings and prioritizations of type CUSTOM. For Fences and Ratings
provided by fulfillmenttools you can not change the fields 'name' and
'description'.
Also you can not delete an existing fulfillmenttools
Fence or Rating by calling this endpoint.
operationId: putRoutingConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingConfiguration'
required: true
summary: Update routing configuration of a tenant
/api/configurations/routing/rerouteshortpick:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteShortPickConfiguration'
description: >-
Reroute short pick configuration was found & you were allowed to
access it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Reroute configuration not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getRerouteShortPickConfiguration
summary: Get a tenant reroute short pick config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteShortPickConfiguration'
description: Reroute short pick configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Reroute short pick configuration not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putRerouteShortPickConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteShortPickConfiguration'
required: true
summary: Update reroute short pick configuration of a tenant
/api/configurations/routing/reroutetimetriggered:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteTimeTriggeredConfiguration'
description: >-
Reroute time triggered configuration was found & you were allowed to
access it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Reroute configuration not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getRerouteTimeTriggeredConfiguration
summary: Get a tenant reroute time triggered config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteTimeTriggeredConfiguration'
description: Reroute time triggered configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Reroute configuration not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putRerouteTimeTriggeredConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteTimeTriggeredConfiguration'
required: true
summary: Update reroute time triggered configuration of a tenant
/api/configurations/routing/manualreroute:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ManualRerouteConfiguration'
description: >-
Manual reroute configuration was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Manual reroute configuration not found
tags:
- DOMS - Routing Plans
description: >-
This endpoint is deprecated and has been replaced.
Deprecated, use GlobalManualRerouteConfiguration in
/api/configurations/routing
deprecated: true
operationId: getManualRerouteConfiguration
summary: Get a tenant manual order reroute config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ManualRerouteConfiguration'
description: Manual order reroute configuration was written successfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Reroute configuration not found
tags:
- DOMS - Routing Plans
description: >-
This endpoint is deprecated and has been replaced.
Deprecated, use GlobalManualRerouteConfiguration in
/api/configurations/routing
deprecated: true
operationId: putManualRerouteConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManualRerouteConfiguration'
required: true
summary: Update manual order reroute configuration of a tenant
/api/configurations/promises:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PromisesConfiguration'
description: >-
Promises configuration was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Promises configuration not found
tags:
- DOMS - Orders
description: ''
operationId: getPromisesConfiguration
summary: Get a tenant promises config
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PromisesConfiguration'
description: The promisesConfiguration was successfully put.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
description: ''
operationId: putPromisesConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromisesConfiguration'
description: Desired promises configuration to put
required: true
summary: Change the tenant wide promises configuration
/api/configurations/stock:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfiguration'
description: StockConfiguration config found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Inventory Management - Stocks
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getStockConfiguration
summary: Get the current stock configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfiguration'
description: The stockConfiguration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Inventory Management - Stocks
description: ''
operationId: putStockConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfiguration'
description: Desired stock configuration to put
required: true
summary: Change the tenant wide stock configuration
/api/configurations/substitution:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: Substitution config found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getSubstitutionConfiguration
summary: Get the current configuration for substitution
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: The substitution configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: The substitution configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putSubstitutionConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutionConfiguration'
description: Desired substitution configuration to create/update
required: true
summary: Change the tenant wide substitution configuration
/api/configurations/supportedlocales:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SupportedLocales'
description: The supported locales can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Configuration
description: ''
operationId: getLocales
summary: Get the list of supported locales
/api/configurations/packing/containerrequired:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: The requirement of containers in packing can be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: >-
This endpoint is deprecated and has been replaced.
Deprecated, will be replaced with /api/configurations/packing
deprecated: true
operationId: getPackingContainerRequirement
summary: Get the packing container requirement configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: >-
The packing container requirement configuration was successfully
updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: >-
The packing container requirement configuration was successfully
created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: >-
This endpoint is deprecated and has been replaced.
Deprecated, will be replaced with /api/configurations/packing
deprecated: true
operationId: putPackingContainerRequirement
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerRequiredConfiguration'
description: Validation picking scan code to activate/deactivate
required: true
summary: Change the tenant wide packing container requirement configuration
/api/configurations/routing/toolkit/fences:
get:
parameters:
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitFencesTransporter'
description: The current list of available toolkit fences
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: No more elements available
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getToolkitFences
summary: Returns all toolkit fences
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitFenceForCreation'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ToolkitFence'
description: Toolkit Fence was created successfully.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: postToolkitFence
summary: Creates a toolkit fence
/api/configurations/routing/toolkit/fences/{toolkitFenceId}:
get:
parameters:
- description: Id of the toolkit fence you want to get
in: path
name: toolkitFenceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitFence'
description: >-
ToolkitFence was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getToolkitFenceById
summary: Get a tag with the given key
put:
parameters:
- description: ID of the toolkit fence you want to update
in: path
name: toolkitFenceId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitFenceForModification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitFence'
description: >-
Toolkit fence was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Toolkit fence not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putToolkitFence
summary: Update a toolkit fence
delete:
parameters:
- description: ID of the toolkit fence you want to delete
in: path
name: toolkitFenceId
required: true
schema:
type: string
responses:
'200':
description: Toolkit fence was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Toolkit fence not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteToolkitFence
summary: Delete a toolkit fence
/api/configurations/routing/toolkit/ratings:
get:
parameters:
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitRatingTransporter'
description: The current list of available toolkit fences
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: No more elements available
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getToolkitRatings
summary: Returns all toolkit ratings
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitRatingForCreation'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ToolkitRating'
description: Toolkit Rating was created successfully.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: postToolkitRating
summary: Creates a toolkit rating
/api/configurations/routing/toolkit/ratings/{toolkitRatingId}:
get:
parameters:
- description: Id of the tag you want to get
in: path
name: toolkitRatingId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitRating'
description: >-
ToolkitRating was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getToolkitRatingById
summary: Get a tag with the given key
put:
parameters:
- description: ID of the toolkit rating you want to update
in: path
name: toolkitRatingId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitRatingForModification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ToolkitRating'
description: >-
Toolkit rating was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Toolkit rating not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putToolkitRating
summary: Update a toolkit rating
delete:
parameters:
- description: ID of the toolkit rating you want to delete
in: path
name: toolkitRatingId
required: true
schema:
type: string
responses:
'200':
description: Toolkit rating was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Toolkit rating not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteToolkitRating
summary: Delete a toolkit rating
/api/deliverynotes:
post:
parameters:
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE
in: query
name: locale
schema:
type: string
responses:
'201':
content:
application/pdf:
schema:
$ref: '#/components/schemas/DeliveryNote'
description: Successfully created the delivery note.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
operationId: createDeliveryNote
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryNote'
required: true
summary: Create delivery note
/api/facilities:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: Reference to the status you want to get the corresponding facilities
explode: true
in: query
name: status
required: false
schema:
type: array
items:
type: string
- description: number of facilities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query facilities with the given tenantFacilityId
in: query
name: tenantFacilityId
required: false
schema:
type: string
- description: query facilities orderBy
in: query
name: orderBy
required: false
schema:
$ref: '#/components/schemas/FacilityOrderBy'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedFacilities'
description: Facilities are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Facilities
description: ''
operationId: getAllFacilities
summary: Return all facilities
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Facility'
description: >-
The facility was successfully created. The Location header contains
the URL of the facility.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Facilities
description: ''
operationId: addFacility
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityForCreation'
description: Representation that describes the facility
required: true
summary: Add a new facility
/api/facilities/{facilityId}:
delete:
parameters:
- description: ID of facility you want to delete
in: path
name: facilityId
required: true
schema:
type: string
- description: cascading deletion without pre condition check
in: query
name: forceDeletion
required: false
schema:
default: false
type: boolean
responses:
'200':
description: Facility was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: ''
operationId: deleteFacility
summary: deletes a facility with the given ID
get:
parameters:
- description: ID of facility you want to get
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Facility'
description: >-
Facility was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: ''
operationId: getFacility
summary: Get a facility with the given ID
patch:
parameters:
- description: ID of facility you want to patch
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Facility'
description: >-
Facility was found & patch-set has been applied. The patched
facility is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
tags:
- Core - Facilities
description: ''
operationId: patchFacility
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityPatchActions'
description: Patch set
required: true
summary: Patches a facility with the given ID
/api/facilities/{facilityId}/actions:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityActionsParameter'
parameters:
- description: Reference to the facility you want to call the action for
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Facility'
description: Updated Facility in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Facilities
operationId: facilityAction
summary: Call a single action on a given facility
/api/facilities/{facilityId}/carriers:
get:
parameters:
- description: ID of facility you want to get
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedCarriers'
description: >-
Carriers are found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: Carriers not found
tags:
- Core - Facilities
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getFacilityCeps
summary: Get the available CEPs for a facility
/api/facilities/{facilityId}/carriers/{carrierRef}:
get:
parameters:
- description: ID of facility you want to get listing
in: path
name: facilityId
required: true
schema:
type: string
- description: >-
The ID that describes the connection of this facility to the
referenced carrier
in: path
name: carrierRef
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnection'
description: >-
Carrier to facility connections was found & you were allowed to
access it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
There is no connection to a carrier with this facility referenced by
the provided facilityCarrierConnectionId
tags:
- Core - Facilities
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getFacilityCarrier
summary: Get the details for a carrier related to the facility with the given ID
post:
parameters:
- description: ID of facility you want to get
in: path
name: facilityId
required: true
schema:
type: string
- description: The referenced carrier ID
in: path
name: carrierRef
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnection'
description: Creation was successful.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
There is no connection to a carrier with this facility referenced by
the provided facilityCarrierConnectionId.
tags:
- Core - Facilities
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createCarrierToFacility
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnectionForCreation'
description: Representation that describes the facility
required: true
summary: >-
Create a connection of a configured carrier to the facility with given
ID
put:
parameters:
- description: ID of facility you want to get
in: path
name: facilityId
required: true
schema:
type: string
- description: The referenced carrier ID
in: path
name: carrierRef
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the parcel label
classifications. If not provided the default locale is used., for
example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnection'
description: Modification was successful.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
There is no connection to a carrier with this facility referenced by
the provided facilityCarrierConnectionId.
tags:
- Core - Facilities
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: connectCarrierToFacility
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCarrierConnectionForModification'
description: Representation that describes the facility
required: true
summary: 'Connect a configured carrier to the facility with given ID '
/api/facilities/{facilityId}/configurations/stock:
get:
parameters:
- description: ID of facility you want to retrieve the configurations for
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityStockConfiguration'
description: Configuration for stock routing was found.
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: No active configurations found for this facility
tags:
- Inventory Management - Stocks
operationId: getFacilityStockConfiguration
summary: >-
Gets the facility's current configuration for stock related order
distribution
patch:
parameters:
- description: ID of facility you want to get
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityStockConfiguration'
description: >-
Facility was found & patch-set has been applied. The patched
facility configuration is in the body.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility Configuration not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
tags:
- Inventory Management - Stocks
description: ''
operationId: patchFacilityConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StockConfigurationPatchActions'
description: Patch set
required: true
summary: Patches a facility configuration with the given ID
/api/facilities/{facilityId}/listings:
get:
parameters:
- description: ID of facility you want to get listing
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of facilities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Array of tenantArticleIds
in: query
name: tenantArticleIds
required: false
explode: false
schema:
type: array
maxItems: 500
items:
type: string
- description: limit results to this scannableCode
in: query
name: scannableCode
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedListings'
description: >-
Facility was found & you were allowed to access it. The results are
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Listings
description: ''
operationId: getFacilityListing
summary: Get a facility with the given ID
put:
parameters:
- description: ID of facility you want to put listings to
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ListingBulkOperationResult'
description: >-
Facility listing was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Core - Listings
description: >-
Bulk PUT for Listings. Please note: This endpoint has legacy behaviour,
i.e. all PUTs fail if a single PUT fails.
operationId: putFacilityListing
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListingsForReplacement'
description: listings for put
required: true
summary: Create or Update listings of a facility with the given ID
delete:
parameters:
- description: ID of facility you want to delete all listings of
in: path
name: facilityId
required: true
schema:
type: string
responses:
'200':
description: Facility listings were found and successfully deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Core - Listings
description: ''
operationId: deleteListingsOfFacility
summary: deletes all listings of a facility with the given ID
/api/facilities/{facilityId}/listings/{tenantArticleId}:
delete:
parameters:
- description: ID of facility you want to delete a listing of
in: path
name: facilityId
required: true
schema:
type: string
- description: tenant ID of the articles listing you want to delete
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: Facility listing was found and successfully deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Core - Listings
description: ''
operationId: deleteFacilityListing
summary: deletes a listing with the given ID of a facility with the given ID
get:
parameters:
- description: ID of facility you want to get listing
in: path
name: facilityId
required: true
schema:
type: string
- description: tenantArticleId of listing you want to get
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Listing'
description: >-
Listing is found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Listings not found
tags:
- Core - Listings
description: ''
operationId: getListing
summary: Get a Listings with the given ID
patch:
parameters:
- description: ID of facility you want to patch a listing of
in: path
name: facilityId
required: true
schema:
type: string
- description: tenant ID of the articles listing you want to patch
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Listing'
type: array
description: Facility listing was found and successfully patched
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Listing version conflict
tags:
- Core - Listings
description: ''
operationId: patchFacilityListing
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListingPatchActions'
description: listings for put
required: true
summary: Update a listing with the given ID of a facility with the given ID
/api/facilities/{facilityId}/listings/{tenantArticleId}/partialstocks:
get:
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
This endpoint is deprecated. Use /api/stocks endpoints instead.
parameters:
- description: ID of facility you want to get the partial stocks
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PartialStock'
type: array
description: >-
Facility and listing were found & you are allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility or Listing not found
tags:
- Core - Listings
operationId: getFacilityListingPartialStock
summary: Get a partial stocks for a listing
put:
deprecated: true
description: >
This endpoint is deprecated and has been replaced.
This endpoint is deprecated. Use /api/stocks endpoints instead.
Replaces the current partial stock object related to its listing
parameters:
- description: ID of facility you want to get listing
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: Facility listing was found & you were allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Core - Listings
operationId: putFacilityListingPartialStock
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PartialStocksForReplacement'
description: Patch set
required: true
summary: Replace partial stocks of a listings of a facility with the given ID
patch:
deprecated: true
description: >
This endpoint is deprecated and has been replaced.
This endpoint is deprecated. Use /api/stocks endpoints instead.
Adds new partial stocks, updates existing partial stocks and keeps
stocks that are previously present in the database.
1. If a stock exists in the patch action but not in the database it is
added.
2. If a stock exists both in the patch action and in the database it is
updated and the contents are merged.
3. If a stock exists only in the database, it is left untouched.
parameters:
- description: ID of facility you want to patch the partial stocks
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: Facility listing was found & you were allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Core - Listings
operationId: patchFacilityListingPartialStock
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PartialStockPatchActions'
description: Patch set
required: true
summary: Patches partial stocks of a listings of a facility with the given ID
delete:
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
This endpoint is deprecated. Use /api/stocks endpoints instead.
parameters:
- description: ID of facility from whom you want to delete the partial stock
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of listing you want to get partial stocks
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: >-
Facility listing was found & you were allowed to delete the partial
stock.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Core - Listings
operationId: deleteFacilityListingPartialStock
summary: Delete partial stocks of a listings of a facility with the given ID
/api/validations/postalcodes:
post:
responses:
'200':
description: The given postal code is valid for the given country
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The given postal code is invalid for the given country
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'422':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The given country can't be validated
tags:
- Core - Validations
description: ''
operationId: validatePostalCode
summary: Validate a given postal code for a given country
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostalCodeValidation'
description: Branding object
required: true
/api/features:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Features'
description: The available feature for all active modules
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Infrastructure - Features
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getFeatures
summary: Returns all features grouped by active modules
/api/features/{featureName}:
get:
parameters:
- description: Name of the feature requested
in: path
name: featureName
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
description: The requested feature
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Infrastructure - Features
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getFeature
summary: Returns a feature
patch:
parameters:
- description: Name of the feature requested
in: path
name: featureName
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Feature'
description: >-
Module was found & patch-set has been applied. The patched entity is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Infrastructure - Features
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: patchFeature
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FeaturePatchActions'
description: Patch set
required: true
summary: Patches a feature
/api/fulfillability:
post:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Fulfillability'
description: The result of the fulfillability .
'204':
description: >-
There was no result of the fulfillability request. Please make sure
to provide at least one of the attributes shipping or collect.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Checkout Options
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
Deprecated: use /api/promises instead
operationId: queryFulfillability
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillabilityQuery'
description: Representation that describes the fulfillability query
required: true
summary: >-
Provides information which kind of fulfillment is possible under given
circumstances.
/api/fulfillability/clickandcollect:
post:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillabilityResult'
description: The result of the fulfillability for click and collect.
'204':
description: >-
There was no result of the fulfillability request. Please make sure
to provide at least one of the attributes shipping or collect.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Checkout Options
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
Deprecated: use /api/promises instead
operationId: queryFulfillabilityClickAndCollect
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillabilityClickAndCollectQuery'
description: Representation that describes the fulfillability query
required: true
summary: >-
Provides information which kind of fulfillment is possible under given
circumstances.
/api/fulfillability/shipfromstore:
post:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillabilityResult'
description: The result of the fulfillability for ship from store.
'204':
description: There was no result of the fulfillability request.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Checkout Options
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
Deprecated: use /api/promises instead
operationId: queryFulfillabilityShipFromStore
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FulfillabilityShipFromStoreQuery'
description: Representation that describes the fulfillability query
required: true
summary: >-
Provides information which kind of fulfillment is possible under given
circumstances.
/api/promises/checkoutoptions:
post:
responses:
'200':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ResponseForCNCCheckoutOptions'
- $ref: '#/components/schemas/ResponseForSFSCheckoutOptions'
description: ''
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: postCheckoutOptions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckoutOptionsInput'
description: The CheckoutOptionsInput
required: true
summary: Evaluate a checkout options input against the DOMS
/api/promises/deliverypromise:
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseForDeliveryPromise'
description: The order promise was created URL of the order promse.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: postDeliveryPromise
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderForCreation'
description: Order object supplied by your shop instance
required: true
summary: Add a new order for future fulfillment
/api/pickruns:
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: >-
The PickRun was successfully created. The Location header contains
the URL of it.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
tags:
- Fulfillment Operations - Picking
description: ''
operationId: addPickRun
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunForCreation'
required: true
summary: Add a new PickRun
/api/pickruns/{pickRunId}:
get:
parameters:
- description: id of pickRun
in: path
name: pickRunId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: PickRun is found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getPickRun
summary: Return a PickRun
patch:
parameters:
- description: id of pickRun
in: path
name: pickRunId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: The updated PickRun.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Version conflict
tags:
- Fulfillment Operations - Picking
description: ''
operationId: patchPickRun
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunPatchAction'
required: true
/api/pickruns/{pickRunId}/pickjobs:
patch:
parameters:
- description: id of pickRun
in: path
name: pickRunId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunPickJobsPatchAction'
responses:
'200':
description: Pick job was successfully from pick run removed.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: patchPickRunPickJobs
summary: Update pick jobs of a pick run
/api/pickruns/{pickRunId}/actions:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickRunActionsParameter'
parameters:
- description: Reference to the pick run you want to call the action for
in: path
name: pickRunId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickRun'
description: Updated Pick Run in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: pickRunAction
summary: Call a single action on a given pickRun
/api/handoverjobs:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: This query can be used to find handoverjobs for a referenced pickjob
in: query
name: pickJobRef
required: false
schema:
type: string
- description: >-
This query can be used to find handoverjobs for a referenced
shipment
in: query
name: shipmentRef
required: false
schema:
type: string
- description: >-
Reference to the facility you want to get the corresponding
handoverJobs
in: query
name: facilityRef
required: false
schema:
type: string
- description: >-
Reference to the status you want to get the corresponding
handoverJobs
explode: true
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the carriers you want to get the corresponding
handoverJobs
in: query
name: carrierRefs
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the channel you want to get the corresponding
handoverJobs
in: query
name: channel
required: false
schema:
type: string
- description: Parameter to filter anonymized handover jobs
in: query
name: anonymized
required: false
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedHandoverjobs'
description: Handoverjobs are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Handover
description: ''
operationId: getAllHandoverjobs
summary: Return all handoverjobs
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: >-
The handoverjob was successfully created. The Location header
contains the URL of it.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Handover
operationId: addHandoverjob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverjobForCreation'
required: true
summary: Add a new handoverjob
/api/handoverjobs/{handoverjobId}:
get:
parameters:
- description: ID of the handoverjob you want to get
in: path
name: handoverjobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: >-
Handoverjob was found & you were allowed to access it. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Handover
description: ''
operationId: getHandoverjob
summary: Get a Handoverjob with the given ID
patch:
parameters:
- description: ID of handoverjob you want to patch
in: path
name: handoverjobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: >-
Handoverjob was found & patch-set has been applied. The patched
entity is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Handover
description: ''
operationId: patchHandoverjob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverjobPatchActions'
description: Patch set
required: true
summary: Patches a handoverjob with the given ID
/api/handoverjobs/{handoverJobId}/actions:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HandoverJobActionsParameter'
parameters:
- description: Reference to the handover job you want to call the action for
in: path
name: handoverJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Handoverjob'
description: Updated Handover job in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Handover
operationId: handoverJobAction
summary: Call a single action on a given Handover job
/api/loadunits:
delete:
parameters:
- description: Reference to the pickJob of which you want to delete the loadUnits
in: query
name: pickJobRef
required: false
schema:
type: string
- description: Load unit ids
explode: true
in: query
name: id
required: false
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnits'
description: Load units are successfully deleted.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'422':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: LoadUnits could not be removed due to failing conditions
tags:
- Fulfillment Operations - Picking
operationId: deleteLoadUnits
summary: Delete loadunits by pickJobRef
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of loadUnits to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query load units with the given pickJobRef
in: query
name: pickJobRef
required: false
schema:
type: string
- description: >-
Provide the localized names and descriptions for the routing
configuration. If not provided the default locale is used., for
example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnits'
description: Load units are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: getAllLoadUnits
summary: Return all load units
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnits'
description: Load units are successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: addLoadUnit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitsForCreation'
description: Representation that describes the unit load
required: true
summary: Add new load units
/api/loadunits/{loadUnitId}:
delete:
parameters:
- in: path
name: loadUnitId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnit'
description: Successfully deleted load unit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: deleteLoadUnit
summary: Delete load unit
get:
parameters:
- in: path
name: loadUnitId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the routing
configuration. If not provided the default locale is used., for
example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnit'
description: The found load unit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: getLoadUnitByID
summary: Get a loadUnit by its ID
patch:
parameters:
- in: path
name: loadUnitId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the routing
configuration. If not provided the default locale is used., for
example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnit'
description: The found load unit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: patchLoadUnitByID
summary: Patch a loadUnit by its ID
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/LoadUnitPatchActions'
- $ref: '#/components/schemas/LoadUnit'
required: true
description: >-
This endpoint is deprecated and has been replaced.
LoadUnitPatchActions: Deprecated - For future usage please use
the /actions endpoints mentioned in the corresponding PatchActions
LoadUnit: Partial Patch on this entity.
deprecated: true
/api/loadunittypes:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: >-
Provide the localized names and descriptions for the routing
configuration. If not provided the default locale is used., for
example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitTypes'
description: All load unit types.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: getLoadUnitTypes
summary: Get all load unit types
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully created resource.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: createLoadUnitTypes
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitTypeForCreation'
required: true
summary: Create new load unit type
/api/loadunittypes/{loadUnitTypeId}:
get:
parameters:
- in: path
name: loadUnitTypeId
required: true
schema:
type: string
- description: >-
Provide the localized names and descriptions for the routing
configuration. If not provided the default locale is used., for
example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: The found load unit type.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: getLoadUnitTypeByID
summary: Get a loadUnitType by its ID
patch:
parameters:
- in: path
name: loadUnitTypeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully updated load unit type.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: updateLoadUnitType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitTypePatchActions'
description: Patch set
required: true
summary: Update load unit type
/api/loadunittypes/{loadUnitTypeId}/icon:
put:
parameters:
- in: path
name: loadUnitTypeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully updated load unit type icon.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnitType'
description: Successfully created load unit type icon.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: uploadLoadUnitTypeIcon
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NamedFile'
description: Base64 encoded icon to upload
required: true
summary: Upload icon for load unit type.
/api/measurementunits:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of measurementUnits to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: key of the measurementUnit
in: query
name: key
required: false
schema:
type: string
- description: >-
Provide the localized names for the measurementUnit. If not provided
the default locale is used., for example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnits'
description: The found measurementUnit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Listings
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getAllMeasurementUnits
summary: Get all measurementUnits
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnit'
description: Successfully created the measurementUnit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Listings
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createMeasurementUnit
requestBody:
$ref: '#/components/requestBodies/MeasurementUnitForCreation'
summary: Create measurementUnit
/api/measurementunits/{measurementUnitId}:
delete:
parameters:
- in: path
name: measurementUnitId
required: true
schema:
type: string
responses:
'200':
description: Successfully deleted the measurementUnit.
'401':
content:
'*/*':
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
'*/*':
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
'*/*':
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Listings
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteMeasurementUnit
summary: Delete measurementUnit
get:
parameters:
- in: path
name: measurementUnitId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnit'
description: The found measurementUnit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Listings
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getMeasurementUnitByID
summary: Get a measurementUnit by its ID
put:
parameters:
- in: path
name: measurementUnitId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnit'
description: Successfully updated the measurementUnit.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Listings
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: updateMeasurementUnit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnitForCreation'
required: true
summary: Update measurementUnit
/api/orders:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: filter orders by tenantOrderId
in: query
name: tenantOrderId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedOrders'
description: Orders are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
description: ''
operationId: getAllOrders
summary: Return all orders
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: >-
The order was successfully created. The Location header contains the
URL of the order.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
description: ''
operationId: addOrder
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderForCreation'
description: Order object supplied by your shop instance
required: true
summary: Add a new order for future fulfillment
/api/orders/{orderId}:
get:
parameters:
- description: ID of order you want to get
in: path
name: orderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: >-
Order was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- DOMS - Orders
description: ''
operationId: getOrder
summary: Get a order with the given ID
/api/orders/{orderId}/actions:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrderActionsParameter'
parameters:
- description: Reference to the order you want to call the action for
in: path
name: orderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: Updated Order in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Orders
operationId: orderAction
summary: Call a single action on a given order
/api/orders/{orderId}/cancel:
post:
parameters:
- description: ID of order you want to cancel
in: path
name: orderId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
description: Order was cancelled sucessfully
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- DOMS - Orders
operationId: cancelOrder
summary: Cancel an order with the given ID
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
Deprecated: Use /actions with "CANCEL" instead.
/api/parcels:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedParcels'
description: Parcels are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: getAllParcels
summary: Return all parcels
/api/parcels/{parcelId}:
delete:
parameters:
- description: ID of the parcel you want to delete
in: path
name: parcelId
required: true
schema:
type: string
responses:
'200':
description: Parcel was successfully deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: deleteParcel
summary: Delete a parcel with the given ID
get:
parameters:
- description: ID of the parcel you want to get
in: path
name: parcelId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: >-
Parcel was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: getParcel
summary: Get a parcel with the given ID
patch:
parameters:
- description: ID of the parcel you want to get
in: path
name: parcelId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: Successfully updated the parcel.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: patchParcel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelPatchActions'
description: Patch set
required: true
summary: Patches a parcel with the given ID
/api/parcels/{parcelId}/labels/{labelDocument}:
get:
parameters:
- description: ID of the parcel you want to get a label for
in: path
name: parcelId
required: true
schema:
type: string
- description: >-
Within a parcel different labels can be created. The following types
of labels are currently supported: all.pdf, send.pdf and return.pdf
= Parcel label plus (if configured) retoure label.
in: path
name: labelDocument
required: true
schema:
enum:
- return.pdf
- all.pdf
- send.pdf
- customs.pdf
type: string
responses:
'200':
content:
application/pdf: {}
description: >-
Parcel was found & you were allowed to access it. The label is in
the body.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: getLabelForParcel
summary: Get a label for the parcel with the given ID
/api/parcels/{parcelId}/deliverynote:
get:
parameters:
- description: ID of parcel you want to retrieve deliveryNote for
in: path
name: parcelId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf:
schema:
$ref: '#/components/schemas/DeliveryNote'
description: Get delivery note as pdf.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Parcel not found
tags:
- Fulfillment Operations - Shipments
operationId: getParcelDeliveryNote
summary: Get deliveryNote for a parcel
/api/parcels/{parcelId}/returnnote:
get:
parameters:
- description: ID of parcel you want to retrieve returnNote for
in: path
name: parcelId
required: true
schema:
type: string
- description: >-
Provide the localized values for the returnNote. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ReturnNote'
description: Get delivery note as pdf.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Parcel not found
tags:
- Fulfillment Operations - Shipments
operationId: getParcelReturnNote
summary: Get returnNote for a parcel
/api/pickjobs:
get:
parameters:
- description: >-
Search term you want to get the corresponding pickjobs. Search will
be performed on multiple fields, like tenantOrderId, consumerName,
tenantArticleId and more
in: query
name: searchTerm
required: false
schema:
type: string
- description: Reference to the carrier you want to get the corresponding pickjobs
explode: false
in: query
name: carrierKeys
required: false
schema:
items:
type: string
maxItems: 100
type: array
- description: >-
Reference to the orderDate you want to get the corresponding
pickjobs
in: query
name: startOrderDate
required: false
schema:
type: string
- description: >-
Reference to the orderDate you want to get the corresponding
pickjobs
in: query
name: endOrderDate
required: false
schema:
type: string
- description: Reference to the order you want to get the corresponding pickjobs
in: query
name: orderRef
required: false
schema:
type: string
- description: Reference to the facility you want to get the corresponding pickjobs
in: query
name: facilityRef
required: false
schema:
type: string
- description: Reference to the status you want to get the corresponding pickjobs
explode: false
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Reference to the zones you want to get the corresponding pickjobs
explode: false
in: query
name: zoneRefs
required: false
schema:
items:
type: string
type: array
- description: >-
Reference to the tenantOrderId you want to get the corresponding
pickjobs
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: The channel of the pickJob you want to filter by
in: query
name: channel
required: false
schema:
enum:
- COLLECT
- SHIPPING
type: string
- description: >-
Reference to the consumer name you want to get the corresponding
pickjobs
in: query
name: consumerName
required: false
schema:
type: string
- description: Reference to the shortId you want to get the corresponding pickjobs
in: query
name: shortId
required: false
schema:
type: string
- description: >-
Reference to the articleTitle you want to get the corresponding
pickjobs
in: query
name: articleTitle
required: false
schema:
type: string
- description: >-
Reference to the anonymized you want to get the corresponding
pickjobs
in: query
name: anonymized
required: false
schema:
type: boolean
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query pickjobs orderBy
in: query
name: orderBy
required: false
schema:
type: string
- description: Start date range for pick jobs
in: query
name: startTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: End date range for pick jobs
in: query
name: endTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: Reference to pickjobs
explode: false
in: query
name: pickJobRefs
required: false
schema:
items:
type: string
maxItems: 100
type: array
- description: Reference to the user ID you want to get the corresponding pickjobs
in: query
name: modifiedByUsername
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedPickJobs'
description: PickJobs were found. The results are in the body.
'204':
description: No PickJobs were found as a result to the given query.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: queryPickJobs
summary: Simple query interface to find pickjobs
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: >-
The pick job was successfully created. The Location header contains
the URL of the pickjob.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: addPickJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobForCreation'
description: Pick job object
required: true
summary: Add a new pick job for fulfillment
/api/documents/{documentId}/file:
get:
parameters:
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
description: The document with given id
tags:
- Core - Processes
description: ''
operationId: downloadProcessDocument
summary: Download a document
/api/documentSet/{documentSetRef}:
get:
parameters:
- description: Reference to the entity you want to get
in: path
name: documentSetRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSet'
description: Documents were found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Document Sets
operationId: getDocumentSetDeprecated
summary: Simple query interface to find documents
deprecated: true
description: Deprecated, use /api/documentsets/{documentSetRef} instead
/api/documentSet/{documentSetRef}/documents:
post:
parameters:
- description: Reference to the documentSet you want to add a file to
in: path
name: documentSetRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalPrintableDocumentForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Document was found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Document Sets
operationId: addDocumentDeprecated
deprecated: true
description: Deprecated, use /api/documentsets/{documentSetRef}/documents instead
/api/documentSet/{documentSetRef}/documents/{documentRef}:
patch:
parameters:
- description: Reference to the documentSet you want to update
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to update
in: path
name: documentRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocumentForUpdate'
description: PartialDocument
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Document was found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Document Sets
operationId: updateDocumentDeprecated
summary: Simple query interface to find documents
deprecated: true
description: >-
Deprecated, use
/api/documentsets/{documentSetRef}/documents/{documentRef} instead
/api/documentSet/{documentSetRef}/documents/{documentRef}/file:
get:
parameters:
- description: Reference to the documentSet you want to download a file from
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to download
in: path
name: documentRef
required: true
schema:
type: string
responses:
'200':
description: The document as a stream
tags:
- Core - Document Sets
description: ''
operationId: downloadDocumentDeprecated
summary: Download a document
put:
parameters:
- description: Reference to the documentSet you want to update
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to update
in: path
name: documentRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentContentForUpdate'
description: Document Content with id and version
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Changed Document
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Document Sets
operationId: addContentToDocumentDeprecated
deprecated: true
description: >-
Deprecated, use
/api/documentsets/{documentSetRef}/documents/{documentRef}/file instead
/api/documentsets/{documentSetRef}:
get:
parameters:
- description: Reference to the entity you want to get
in: path
name: documentSetRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentSet'
description: Documents were found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Document Sets
operationId: getDocumentSet
description: ''
summary: Simple query interface to find documents
/api/documentsets/{documentSetRef}/documents:
post:
parameters:
- description: Reference to the documentSet you want to add a file to
in: path
name: documentSetRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalPrintableDocumentForCreation'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Document was found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Document Sets
operationId: addDocument
/api/documentsets/{documentSetRef}/documents/{documentRef}:
patch:
parameters:
- description: Reference to the documentSet you want to update
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to update
in: path
name: documentRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocumentForUpdate'
description: PartialDocument
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Document was found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Document Sets
operationId: updateDocument
summary: Simple query interface to find documents
/api/documentsets/{documentSetRef}/documents/{documentRef}/file:
get:
parameters:
- description: Reference to the documentSet you want to download a file from
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to download
in: path
name: documentRef
required: true
schema:
type: string
responses:
'200':
description: The document as a stream
tags:
- Core - Document Sets
description: ''
operationId: downloadDocument
summary: Download a document
put:
parameters:
- description: Reference to the documentSet you want to update
in: path
name: documentSetRef
required: true
schema:
type: string
- description: Reference to the single document you want to update
in: path
name: documentRef
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentContentForUpdate'
description: Document Content with id and version
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PrintableDocument'
description: Changed Document
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Document Sets
operationId: addContentToDocument
/api/pickjobs/{pickJobId}/actions:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobActionsParameter'
parameters:
- description: Reference to the pick job you want to call an action for
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: Updated PickJob in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: pickJobAction
summary: Call a single action on a given pickJob
/api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes:
get:
parameters:
- description: Reference to the pick job you to get the available substitutes for
in: path
name: pickJobId
required: true
schema:
type: string
- description: >-
Reference to the pickLineItem you to get the available substitutes
for
in: path
name: pickLineItemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ResolvedSubstitutes'
description: Available substitutes for given pickLineItem
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: queryPickLineItemsSubstitutes
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/pickjobs/{pickJobId}/loadunits:
get:
parameters:
- description: >-
Reference to the pick job you want to get the corresponding
loadunits
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LoadUnits'
description: Loadunits were found. The results are in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
operationId: queryPickJobLoadUnits
summary: Simple query interface to find load units of a pickjob
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingLoadUnit'
description: The load units was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: addPickJobLoadUnits
parameters:
- description: >-
Reference to the pick job you want to get the corresponding
loadunits
in: path
name: pickJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickingLoadUnitForCreation'
description: Pick job load unit object
required: true
summary: Add a new load unit for pick job
/api/pickjobs/{pickJobId}:
get:
parameters:
- description: ID of the pickjob you want to get
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: >-
PickJob was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getPickJob
summary: Get a pick job with the given ID
patch:
parameters:
- description: ID of the pickjob you want to get
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJob'
description: >-
PickJob was found & patch-set has been applied. The patched pick job
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: PickJob not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: PickJob version conflict
tags:
- Fulfillment Operations - Picking
description: ''
operationId: patchPickJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickingPatchActions'
description: Patch set
required: true
summary: Patches a pick job with the given ID
/api/pickjobs/{pickjobId}/returnnote:
get:
parameters:
- description: ID of the Pickjob
in: path
name: pickjobId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: Returns a return note for the pickjob.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getReturnNotesForPickjob
summary: Get the return note for the pickjob with the given ID
/api/pickjobs/{pickJobId}/deliverynote:
get:
parameters:
- description: ID of the pick job for which you want to get a deliverynote
in: path
name: pickJobId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The deliverynote for the given pickjob
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getPickJobDeliveryNote
summary: Get a deliverynote for the pick job with the given ID
/api/process:
get:
parameters:
- in: query
name: tenantOrderId
required: false
schema:
type: string
- in: query
name: orderRef
required: false
schema:
type: string
- in: query
name: pickJobRef
required: false
schema:
type: string
- in: query
name: shipmentRef
required: false
schema:
type: string
- in: query
name: handoverJobRef
required: false
schema:
type: string
- in: query
name: returnRef
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: Process belonging to the given parameters
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The given parameters are invalid
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getProcesses
summary: >-
Returns a process belonging to the given parameters. At least one
parameter needs to be supplied.
/api/processes:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Reference to the status you want to get the corresponding processes
explode: true
in: query
name: status
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the operativeStatus you want to get the corresponding
processes
explode: true
in: query
name: operativeStatus
required: false
schema:
type: array
items:
type: string
- description: Perform full text search base on the tenantOrderId
in: query
name: tenantOrderId
required: false
schema:
type: string
- description: >-
Return the Processes which have related pickjobs with a targettime
on or after this date
in: query
name: startTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: >-
Return the Processes which have related pickjobs with a targettime
on or before this date
in: query
name: endTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: Return the Processes created on or after this date
in: query
name: startDate
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: Return the Processes created on or before this date
in: query
name: endDate
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: Id's of the facilities from which you want to get the processes
explode: true
in: query
name: facilityRefs
required: false
schema:
type: array
items:
type: string
- description: Consumer country codes from which you want to get the processes
explode: true
in: query
name: countries
required: false
schema:
type: array
items:
type: string
- description: Facility country codes from which you want to get the processes
explode: true
in: query
name: facilityCountries
required: false
schema:
type: array
items:
type: string
- description: Brand ids for which you want to get the processes
explode: true
in: query
name: brandRefs
required: false
schema:
type: array
items:
type: string
- description: Order delivery preferences service level
explode: true
in: query
name: serviceLevels
required: false
schema:
type: array
items:
type: string
enum:
- DELIVERY
- SAMEDAY
- description: Whether an order is click and collect or delivery
explode: true
in: query
name: serviceTypes
required: false
schema:
type: array
items:
type: string
enum:
- COLLECT
- SHIPPING
- description: >-
Reference to the orderDomainStatus you want to get the corresponding
processes
explode: true
in: query
name: orderDomainStatus
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the routingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: routingDomainStatus
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the pickingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: pickingDomainStatus
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the packingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: packingDomainStatus
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the shippingDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: shippingDomainStatus
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the handoverDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: handoverDomainStatus
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the returnDomainStatus you want to get the
corresponding processes
explode: true
in: query
name: returnDomainStatus
required: false
schema:
type: array
items:
type: string
- description: Stickers attached to a order
explode: true
in: query
name: stickers
required: false
schema:
type: array
items:
type: string
- description: Perform full text search over all searchable attributes
in: query
name: searchTerm
required: false
schema:
type: string
- description: SortingParameter name for the query
in: query
name: sortBy
required: false
schema:
$ref: '#/components/schemas/SortParameterName'
- description: Sorting direction for the query
in: query
name: sortByDirection
required: false
schema:
$ref: '#/components/schemas/SortDirection'
- description: '@deprecated Use orderStatus instead'
in: query
name: locked
required: false
schema:
type: boolean
- description: Order status for the query
in: query
name: orderStatus
required: false
schema:
$ref: '#/components/schemas/OrderStatus'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Processes'
description: Process are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getAllProcesses
summary: Return all processes
/api/processes/retrynotroutable:
post:
responses:
'204':
description: >-
The retry for all not routable proceses has been succesfully
triggered
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: The retry task can not be triggered due to a conflicting operation
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Processes
description: ''
operationId: triggerRetryNotRoutable
summary: triggers the retry of not routable plans
/api/processes/{processId}:
patch:
parameters:
- description: ID of process you want to patch
in: path
name: processId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: >-
Process was found & patch-set has been applied. The patched process
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Process not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Process version conflict
tags:
- Core - Processes
description: ''
operationId: patchProcess
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessPatchActions'
description: Patch set
required: true
summary: Patches a process with the given ID
get:
parameters:
- in: path
name: processId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: The found process.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getProcessByID
summary: Get a process by its ID
/api/processes/{processId}/reroute:
post:
parameters:
- description: ID of process you want to reroute
in: path
name: processId
required: true
schema:
type: string
- description: Version of process you want to reroute
in: query
name: version
required: true
schema:
type: number
- description: The id of the rerouteDescription
in: query
name: rerouteDescriptionId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Process'
description: >-
Process was found the corresponding reroute operations have been
triggered.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Process not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Process version conflict
tags:
- Core - Processes
description: ''
operationId: postProcess
summary: Reroutes a process with the given ID
/api/processes/{processId}/documents:
post:
parameters:
- in: path
name: processId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocument'
description: The document was successfully created
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentForCreation'
description: ''
required: true
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: addDocumentToProcess
summary: Create a new document on this process
/api/processes/{processId}/documents/{documentId}/file:
get:
parameters:
- in: path
name: processId
required: true
schema:
type: string
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The document with given id attached to the selected process
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: downloadDocumentInProcess
summary: Read a document on this process
put:
parameters:
- in: path
name: processId
required: true
schema:
type: string
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocument'
description: The document was successfully updated
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocumentForUpdate'
description: ''
required: true
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: updateDocumentInProcess
summary: Update a document on this process
/api/processes/{processId}/documents/{documentId}:
get:
parameters:
- in: path
name: processId
required: true
schema:
type: string
- in: path
name: documentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDocument'
description: >-
The document meta information with given id attached to the selected
process
tags:
- Core - Processes
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: readDocumentMetaInProcess
summary: Read meta information about document on this process
/api/returns:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJobs'
description: Return Jobs that were found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Returns
operationId: getReturnJobs
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show (max 500 per request)
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Reference to the facility you want to filter for
in: query
name: facilityRef
required: false
schema:
type: string
- description: >-
Reference to the status you want to get the corresponding return
jobs to
in: query
name: status
required: false
schema:
items:
type: string
type: array
summary: Get Return Jobs
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJob'
description: The return was successfully created
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Returns
description: >-
This endpoint is deprecated and has been replaced.
deprecated: true
operationId: addReturn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJobForCreation'
description: 'ReturnJob object '
required: true
summary: Add a new return
/api/returns/{returnId}:
get:
parameters:
- description: ID of the return you want to get
in: path
name: returnId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJob'
description: >-
Return was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Fulfillment Operations - Returns
description: >-
This endpoint is deprecated and has been replaced.
Will be replaced in the future with the new /itemreturnjob.
deprecated: true
operationId: getReturnLines
summary: Get return with the given return ID
patch:
parameters:
- description: ID of return you want to patch
in: path
name: returnId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnJob'
description: >-
Return was found & patch-set has been applied. The patched entity is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Returns
description: >-
This endpoint is deprecated and has been replaced.
operationId: patchReturn
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnPatchActions'
description: Patch set
required: true
summary: Patches a return with the given ID
deprecated: true
/api/routing/commands/reroute:
post:
responses:
'200':
description: Rerouting was successfully triggered
'401':
content:
'*/*':
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
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
summary: Triggers rerouting of failed routing plans
/api/routingplans:
get:
parameters:
- description: >-
Reference to the order you want to get the corresponding routing
plan.
in: query
name: orderRef
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlans'
description: >-
Routing plan was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found, please look at details.
tags:
- DOMS - Routing Plans
description: ''
operationId: getRoutingPlanBaseOnOrderRef
summary: Get a routing plan regarding to orderRef
/api/routingplans/{routingplanId}:
get:
parameters:
- description: ID of the routing plan want to get
in: path
name: routingplanId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlan'
description: >-
Routing plan was found & you were allowed to access it. The result
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Not found, please look at details.
tags:
- DOMS - Routing Plans
description: ''
operationId: getRoutingPlan
summary: Get a routing plan with the given ID
patch:
parameters:
- description: ID of routing plan you want to patch
in: path
name: routingplanId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlan'
description: >-
Routing plan was found & patch-set has been applied. The patched
entity is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found, for more information please look at details.
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- DOMS - Routing Plans
description: ''
operationId: patchRoutingPlan
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RoutingPlanPatchActions'
description: Patch set
required: true
summary: Patches a routing plan with the given ID
/api/routingplans/{routingplanId}/decisionlogs/{routingRun}:
get:
parameters:
- description: ID of the routing plan you want to get it's decision log
in: path
name: routingplanId
required: true
schema:
type: string
- description: ID of the decision log you want to get
in: path
name: routingRun
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionLog'
description: Decision log was found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Decision log not found
tags:
- DOMS - Routing Plans
description: ''
operationId: getDecisionlog
summary: Get decision log of a routing plan with the given ID
/api/reroutedescriptions:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescriptions'
description: >-
RerouteDescription were found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getRerouteDescriptions
summary: Get a list with all reroute descriptions
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescription'
description: >-
The RerouteDescription has been successfully created. The Location
header includes the URL of the document.
'303':
description: >-
The RerouteDescription already exists. The Location header contains
the URL of the document.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- DOMS - Routing Plans
operationId: postRerouteDescription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescriptionForCreation'
description: The RerouteDescription
required: true
summary: Post a new RerouteDescription
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/reroutedescriptions/{rerouteDescriptionId}:
get:
parameters:
- description: Id of the reroute description you wish to retrieve
in: path
name: rerouteDescriptionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescription'
description: >-
RerouteDescription was found & you were allowed to access it. The
result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getRerouteDescriptionById
summary: Get a reroute description with the given key
put:
parameters:
- description: ID of the reroute description you intend to modify
in: path
name: rerouteDescriptionId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescriptionForModification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RerouteDescription'
description: >-
RerouteDescription rating was found & you were allowed to access it.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: RerouteDescription not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: putRerouteDescription
summary: Update a reroute description
delete:
parameters:
- description: ID of the reroute description you intend to delete
in: path
name: rerouteDescriptionId
required: true
schema:
type: string
responses:
'200':
description: >-
The reroute description was found, and you have been granted
permission to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: RerouteDescription not found
tags:
- DOMS - Routing Plans
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteRerouteDescription
summary: Delete a reroute description
/api/scopedcapabilities:
get:
parameters:
- description: id of the facility
in: query
name: facilityId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ScopedCapabilities'
description: All ScopedCapabilities whic are at least inactive
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Infrastructure - Features
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getCapabilities
summary: >-
Returns all scopedcapabilities which are at least inactive and available
to a facility/user
/api/shipments:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: This query can be used to find shipments for a referenced pickjob
in: query
name: pickJobRef
required: false
schema:
type: string
- description: >-
This query can be used to find shipments belonging to the referenced
facility
in: query
name: facilityRef
required: false
schema:
type: string
- description: This query can be used to find shipments for a referenced carrier
in: query
name: carrierRef
required: false
schema:
type: string
- description: Find shipments with one the the given carriers
explode: false
in: query
name: carrierKeys
required: false
schema:
items:
type: string
type: array
- description: Find shipments in one of the given status
explode: false
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Find shipments with parcels in one of the given status
explode: false
in: query
name: parcelStatus
required: false
schema:
items:
type: string
type: array
- description: Start date range for shipments
in: query
name: startTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: End date range for shipments
in: query
name: endTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: Parameter to filter anonymized shipments
in: query
name: anonymized
required: false
schema:
type: boolean
- description: >-
Fulltext search in shipment's tenantOrderId, shortId,
parcels.carrierTrackingNumber, lineItems.article.tenantArticleId,
lineItems.article.title, invoiceAddress, targetAddress and
customerName
in: query
name: searchTerm
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedShipments'
description: Shipments are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: getAllShipments
summary: Return all shipments
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: >-
The Shipment was successfully created. The Location header contains
the URL of the Shipment.
'303':
description: >-
The Shipment already exists. The Location header contains the URL of
the Shipment.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
operationId: addShipment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentForCreation'
description: Shipment object supplied by your picking app
required: true
summary: Add a new Shipment
/api/shipments/{shipmentId}:
get:
parameters:
- description: ID of Shipment you want to get
in: path
name: shipmentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: >-
Shipment was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Shipment not found
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: getShipment
summary: Get a Shipment with the given ID
patch:
parameters:
- description: ID of shipment you want to patch
in: path
name: shipmentId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Shipment'
description: >-
Shipment was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: patchShipment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ShipmentPatchActions'
description: Patch set
required: true
summary: Patches a shipment with the given ID
/api/shipments/{shipmentId}/deliverynote:
get:
parameters:
- description: ID of shipment you want to retrieve delivery note for
in: path
name: shipmentId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf:
schema:
$ref: '#/components/schemas/DeliveryNote'
description: Get delivery note as pdf.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Shipment not found
tags:
- Fulfillment Operations - Shipments
operationId: getShipmentDeliveryNote
summary: Get delivery note for a shipment
/api/shipments/{shipmentId}/parcels:
post:
parameters:
- description: ID of shipment you want to create parcel for
in: path
name: shipmentId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Parcel'
description: >-
The Parcel was successfully created. The Location header contains
the URL of the Shipment.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'422':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Parcel could not be processed due to failing conditions
tags:
- Fulfillment Operations - Shipments
description: ''
operationId: addParcel
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/ParcelForCreation'
description: Payload of the parcel you want to create
summary: Creates a new parcel for a shipment
/api/status:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
description: The status result
tags:
- Infrastructure - Health
description: ''
operationId: status
summary: A public status endpoint that renders general availability information
/api/subscriptions:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscriptions'
description: All subscriptions.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Eventing
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getSubscriptions
summary: Get all subscriptions
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: Subscription is successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Eventing
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: addSubscription
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionForCreation'
description: Representation that describes the subscription
required: true
summary: >-
Add new Subscription. Please note: Currently it is only possible to add
one subscription per event.
/api/subscriptions/{subscriptionId}:
delete:
parameters:
- description: ID of the subscription you want to delete
in: path
name: subscriptionId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Subscription'
description: Subscription is successfully deleted.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Eventing
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteSubscription
summary: Delete subscription by Id
/api/substitutes:
get:
parameters:
- description: the tenantArticleId substitutes are requested for
in: query
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Substitutes'
description: >-
There are substitutes for the given tenantArticleId. The result can
be found in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Fulfillment Operations - Picking
operationId: getResultingSubstitutesForTenantArticleId
summary: Get the resulting substitutes for a specific tenantArticleId.
/api/substitutes/{tenantArticleId}:
delete:
parameters:
- description: the tenant article ID the subsitutes should be deleted for
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
description: >-
The substitutes for the given tenantArticleId were successfully
deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: deleteSubstitutesForTenantArticleId
summary: deletes substitutes for the given tenant article id
get:
parameters:
- description: ''
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Substitutes'
description: >-
The substitutes for the given tenantArticleId can be found in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Fulfillment Operations - Picking
description: Get the substitutes for a given tenant article id
operationId: getSubstitutesForTenantArticleId
summary: Get the substitutes for a given tenant article id
put:
parameters:
- description: Tenant article ID of the article the substitutes should be set for
in: path
name: tenantArticleId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Substitutes'
description: The substitutes for tenantArticleId were successfully updated
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility listing not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putSubstitutesForTenantArticleID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubstitutesForUpsert'
description: substitutes to set
required: true
summary: Set possible substitutes for a tenant article ID
/api/supportedevents:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SupportedEvents'
description: All supported events.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Eventing
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getEvents
summary: Get a list of supported events you can subscribe to.
/api/users:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: query users orderBy
in: query
name: orderBy
required: false
schema:
$ref: '#/components/schemas/UserOrderBy'
- description: filter by facility id
in: query
name: facilityId
required: false
schema:
type: string
- description: include admin users without a facility
in: query
name: includeAdminUsers
required: false
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedUsers'
description: User are found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - User Management
description: ''
operationId: getAllUsers
summary: Return all users
post:
responses:
'201':
description: The user is successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - User Management
description: ''
operationId: createUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserForCreation'
description: User object
required: true
summary: Create a new user
/api/users/branding/{clientName}:
put:
parameters:
- description: Identifier for the client you want to set the branding for.
in: path
name: clientName
required: true
schema:
type: string
responses:
'200':
description: The branding was successfully set.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Unknown clientName
tags:
- Core - User Management
operationId: putBranding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Branding'
description: Branding object
required: true
summary: 'Sets the branding '
description: >-
This endpoint is deprecated and has been replaced.
Deprecated, will be replaced by /api/configurations/tenant
/api/users/sign/transloadit/{templateId}:
get:
parameters:
- description: The id of the template to sign the request
in: path
name: templateId
required: true
schema:
type: string
responses:
'200':
description: The signed request is returned.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - User Management
description: >-
This endpoint is deprecated and has been replaced.
Deprecated, image upload is no longer supported
operationId: signTransloaditRequest
summary: Sign an upload request for a given template
/api/users/{userId}:
delete:
parameters:
- description: user ID of the user you want to delete
in: path
name: userId
required: true
schema:
type: string
responses:
'200':
description: User was found and successfully deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Core - User Management
description: ''
operationId: deleteUser
summary: Deletes a User with the given ID
get:
parameters:
- description: ID of User you want to get
in: path
name: userId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/User'
description: >-
User was found & you were allowed to access it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Core - User Management
description: ''
operationId: getUser
summary: Get a User with the given ID
patch:
parameters:
- description: ID of the user you want to patch
in: path
name: userId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/User'
description: The user is successfully modified.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility version conflict
tags:
- Core - User Management
description: ''
operationId: patchUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserPatchActions'
description: ModifyUser object
required: true
summary: Patch an existing user with the given ID
/api/users/{userId}/permissions:
get:
parameters:
- description: ID of User you want to get
in: path
name: userId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Roles'
description: >-
User was found & you were allowed to access it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Core - User Management
description: ''
operationId: getUserRoles
summary: Get a User with the given ID
/api/users/{userId}/assignedFacilities:
post:
parameters:
- description: ID of User you want to assign a facility
in: path
name: userId
required: true
schema:
type: string
responses:
'200':
description: The facility was correctly assigned
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserAssignedFacilityForCreation'
description: The facility you want to assign the user
required: true
tags:
- Core - User Management
description: ''
operationId: postAssignedFacilities
summary: Assigns a facility to an user
/api/users/{userId}/assignedFacilities/{assignedFacilityId}:
delete:
parameters:
- description: User ID from whom you want to delete the facility
in: path
name: userId
required: true
schema:
type: string
- description: Facility id you want to delete from the user
in: path
name: assignedFacilityId
required: true
schema:
type: string
responses:
'200':
description: The assigned facility was correctly removed from the user.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Core - User Management
description: ''
operationId: deleteAssignedFacilities
summary: Removes an assigned facility from the user
/api/brands:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedBrands'
description: All brands on listings for this tenant
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Processes
description: ''
operationId: getAllBrands
summary: Return all brands
/api/returnnotes:
post:
parameters:
- description: >-
Provide the localized values for the return note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'201':
content:
application/pdf:
schema:
$ref: '#/components/schemas/ReturnNote'
description: Successfully created the return note.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Shipments
operationId: createReturnNote
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnNote'
required: true
summary: Create return note
/api/packjobs:
get:
parameters:
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: Parameter to filter anonymized pack jobs
in: query
name: anonymized
required: false
schema:
type: boolean
- description: Reference to the status you want to get the corresponding pickjobs
explode: false
in: query
name: status
required: false
schema:
items:
type: string
type: array
- description: Reference to the facility you want to get the corresponding packjobs
in: query
name: facilityRef
required: false
schema:
type: string
- description: Term by which to search through the fields
in: query
name: searchTerm
required: false
schema:
type: string
- description: Reference to the channel you want to get the corresponding packjobs
in: query
name: channel
required: false
schema:
enum:
- COLLECT
- SHIPPING
type: string
- description: filter by packingsourcecontainer containing codes
in: query
name: sourceContainerCodes
required: false
schema:
type: array
items:
type: string
- description: query packjobs orderBy
in: query
name: orderBy
required: false
schema:
type: string
- description: Start date range for pack jobs
in: query
name: startTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: End date range for pack jobs
in: query
name: endTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobs'
description: >-
Pack jobs was loaded & you were allowed to access it. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackJobs
summary: Get all pack jobs
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: >-
The pack job was successfully created. The Location header contains
the URL of the pack job.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: ''
operationId: addPackJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobForCreation'
description: Pack job object
required: true
summary: Add a new pack job
/api/packingcontainertypes:
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerType'
description: >-
The packing container type was successfully created. The Location
header contains the URL of the packing container type.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: ''
operationId: addPackingContainerType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerTypeForCreation'
description: Packing type object
required: true
summary: Add a new packing container type
get:
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: all entities after given id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PackingContainerType'
type: array
description: Found PackingContainerTypes
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackingContainerTypes
summary: Get all packing container types
/api/packingcontainertypes/{packingContainerTypeId}:
get:
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: id of entity
in: path
name: packingContainerTypeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerType'
description: Found PackingContainerType
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackingContainerType
summary: Get a packing container type by its id
patch:
parameters:
- description: ID of the packingcontainertype you want to change
in: path
name: packingContainerTypeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerType'
description: >-
PackingContainerType was found & patch-set has been applied. The
patched PackingContainerType is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: PackingContainerType not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: PackingContainerType version conflict
tags:
- Fulfillment Operations - Packing
description: ''
operationId: updatePackingContainerType
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerTypePatchActions'
description: Patch set
required: true
summary: Patches a PackingContainerType with the given ID
/api/pickjobs/{pickJobId}/documenthandling:
get:
parameters:
- description: ID of the pick job you want to get document handling information
in: path
name: pickJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentHandling'
description: >-
Pick job document handling was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getPickJobDocumentHandling
summary: Get a pick job document handling information with the given ID
/api/packingsourcecontainers/{packingSourceContainerId}:
get:
parameters:
- description: ID of the packingSourceContainer
in: path
name: packingSourceContainerId
required: true
schema:
type: string
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PackingSourceContainer'
type: array
description: Found packingSourceContainer
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Get PackingSourceContainer by ID.
operationId: getPackingSourceContainerById
summary: Get a single packingSourceContainer
/api/packingsourcecontainers:
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingSourceContainer'
description: >-
The packing source container was successfully created. The Location
header contains the URL of the packing source container.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Creating new packingSourceContainer.
operationId: addPackingSourceContainer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingSourceContainerForCreation'
description: Packing type object
required: true
summary: Add a new packingSourceContainer
get:
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: all entities after given id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
maximum: 500
- description: filter by packJobRef
in: query
name: packJobRef
required: false
schema:
type: string
- description: filter by facilityRef
in: query
name: facilityRef
required: true
schema:
type: string
- description: filter by scannablecodes
in: query
name: codes
required: false
schema:
type: array
items:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PaginatedPackingSourceContainers'
type: array
description: Found Packing Source Container
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Listing packingSourceContainer.
operationId: getPackingSourceContainers
summary: Get all packingSourceContainers
/api/packjobs/{packJobId}/documenthandling:
get:
parameters:
- description: ID of the pack job you want to get document handling information
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentHandling'
description: >-
Pack job document handling was found & you were allowed to access
it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackJobDocumentHandling
summary: Get a pack job document handling information with the given ID
/api/packjobs/{packJobId}:
get:
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: >-
Pack job was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackJob
summary: Get a pack job with the given ID
patch:
parameters:
- description: ID of the packjob you want to get
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackJob'
description: >-
PackJob was found & patch-set has been applied. The patched pack job
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: PackJob not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: PackJob version conflict
tags:
- Fulfillment Operations - Packing
description: ''
operationId: patchPackJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackJobPatchActions'
description: Patch set
required: true
summary: Patches a pack job with the given ID
/api/packjobs/{packJobId}/returnnote:
get:
parameters:
- description: ID of the PackJob
in: path
name: packJobId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: Returns a return note for the packjob.
'401':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/pdf:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getReturnNotesForPackJob
summary: Get the return note for the packjob with the given ID
/api/packjobs/{packJobId}/deliverynote:
get:
parameters:
- description: ID of the pack job for which you want to get a deliverynote
in: path
name: packJobId
required: true
schema:
type: string
- description: >-
Provide the localized values for the delivery note. If not provided
the default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
responses:
'200':
content:
application/pdf: {}
description: The deliverynote for the given packjob
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getPackJobDeliveryNote
summary: Get a deliverynote for the pack job with the given ID
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}:
get:
parameters:
- description: >-
Provide the localized values for the entity. If not provided the
default locale is used. For example de_DE.
in: query
name: locale
schema:
type: string
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of the target container you want to get
in: path
name: targetcontainerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainer'
description: >-
Entity was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getTargetcontainer
summary: Get a packing target container with the given ID on given packJob
patch:
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to patch
in: path
name: targetcontainerId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainer'
description: >-
Container was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Packing
operationId: patchTargetcontainer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerPatchActions'
description: Patch set
required: true
summary: Patches a packing container with the given ID
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
post:
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of the container you want to add new line item to it
in: path
name: targetcontainerId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainer'
description: The packing container was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: addTargetcontainer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerLineItemForCreation'
description: Packing Container line item object
required: true
summary: Add a new packing container line item
/api/packjobs/{packJobId}/targetcontainers/{targetcontainerId}/lineitems/{lineItemId}:
patch:
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to patch
in: path
name: targetcontainerId
required: true
schema:
type: string
- description: ID of line item you want to patch
in: path
name: lineItemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainer'
description: >-
Container was found & patch-set has been applied. The patched entity
is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Patch line item of a packing container
operationId: patchTargetContainerLineItem
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerActionsParameter'
description: Patch set
required: true
summary: Patches a packing container with the given ID
delete:
parameters:
- description: ID of corresponding packJob you want to patch
in: path
name: packJobId
required: true
schema:
type: string
- description: ID of container you want to patch
in: path
name: targetcontainerId
required: true
schema:
type: string
- description: ID of line item you want to patch
in: path
name: lineItemId
required: true
schema:
type: string
responses:
'200':
description: LineItem was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteLineItemTargetContainers
summary: deletes a lineItem of a packing container with the given ID
/api/packjobs/{packJobId}/targetcontainers:
get:
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/PackingContainer'
description: >-
Entity was found & you were allowed to access it. The result is in
the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getAllTargetcontainers
summary: Get all packing container on given packJob
post:
parameters:
- description: ID of the pack job you want to get
in: path
name: packJobId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainer'
description: The packing container was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Packing
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: addTargetContainers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PackingContainerForCreation'
description: Packing Container object
required: true
summary: Add a new packing container
/api/tags:
get:
parameters:
- description: all entities
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedTags'
description: The current list of available tags
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: No more elements available
tags:
- Core - Tags
description: ''
operationId: getTags
summary: Returns all tags
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: The tag was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Tags
description: ''
operationId: addTag
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagForCreation'
description: Tag object
required: true
summary: Add a new tag
/api/tags/{tagRef}:
get:
parameters:
- description: Id of the tag you want to get
in: path
name: tagRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: >-
Tag was found & you were allowed to access it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: User not found
tags:
- Core - Tags
description: ''
operationId: getTag
summary: Get a tag with the given key
patch:
parameters:
- description: Id of the tag you want to update
in: path
name: tagRef
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
description: >-
Tag was found & you were allowed to access it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Tag not found
tags:
- Core - Tags
description: ''
operationId: putTag
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TagPatchActions'
description: Tag patch action
required: true
summary: Update a tag with the given key
/api/tags/packing/needspacking:
post:
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TagReference'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/NeedsPacking'
description: >-
NeedsPacking information for this tag was found & you were allowed
to access it. The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Packing
description: ''
operationId: getNeedsPacking
summary: Get packing information for given Tag
/api/restowitems:
get:
parameters:
- description: Reference to the facility you want to get the corresponding restows
in: query
name: facilityRef
required: false
schema:
type: string
- description: Reference restowed status of the restoe items
in: query
name: restowed
required: false
schema:
type: boolean
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowedItems'
description: Restow items were found. The results are in the body.
'204':
description: No restow items were found as a result to the given query.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Restow
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: queryRestowItems
summary: Simple query interface to find restowItems
/api/restowitems/{restowItemId}:
get:
parameters:
- description: ID of the restow item you want to get
in: path
name: restowItemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItem'
description: >-
RestowItem was found & you were allowed to access it. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Restow
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getRestowItem
summary: Get a restow item with the given ID
patch:
parameters:
- description: ID of the restow item you want to update
in: path
name: restowItemId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItem'
description: >-
RestowItem was found & patch-set has been applied. The patched
restow item is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: RestowItem not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: RestowItem version conflict
tags:
- Fulfillment Operations - Restow
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: patchRestowItem
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RestowItemPatchActions'
description: Patch set
required: true
summary: Patches a restow item with the given ID
/api/configurations/picking:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: Central Configuration of all picking related things
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
operationId: getPickingConfigurations
summary: Get the picking configurations
patch:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: The picking central configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: The picking central configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putPickingConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickingConfigurations'
description: create/update picking central configuration
required: true
summary: Change the tenant wide picking central configuration
/api/configurations/tags/pickjob:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobTagConfiguration'
description: pickjob tag config is in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Picking
description: ''
operationId: getPickJobTagConfiguration
summary: Read tag configuration for pickjobs
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobTagConfiguration'
description: The packing configuration was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Picking
description: ''
operationId: putPickJobTagConfigurations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PickJobTagConfiguration'
description: Desired Tag Configuration for Pickjobs
required: true
summary: Change the tag configuration for Pickjobs
/api/remoteconfigs:
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfigurationForCreation'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfiguration'
description: Created entity in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Remote Configuration
operationId: createRemoteConfiguration
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Create a new remote configuration
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: facility to filter to
in: query
name: facilityId
required: false
schema:
type: string
- description: groups to filter to
in: query
name: groups
required: false
schema:
type: array
items:
type: string
- description: userId to filter to
in: query
name: userId
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/RemoteConfiguration'
description: Central RemoteConfiguration
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Remote Configuration
operationId: getAllRemoteConfigurations
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Get all remote configurations
/api/remoteconfigs/{id}:
get:
parameters:
- description: Reference to the remote config you want to get
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfiguration'
description: Central RemoteConfiguration
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Remote Configuration
operationId: getRemoteConfiguration
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Get a single remote configuration
delete:
parameters:
- description: Reference to the remote config you want to delete
in: path
name: id
required: true
schema:
type: string
responses:
'200':
description: Successfully Deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Remote Configuration
operationId: deleteRemoteConfiguration
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Delete a single remote configuration
patch:
parameters:
- description: Reference to the remote config you want to change
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfigurationForUpdate'
responses:
'200':
description: Successfully Changed
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Remote Configuration
operationId: updateRemoteConfiguration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Update a single remote configuration
put:
parameters:
- description: Reference to the remote config you want to change
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfigurationForPut'
responses:
'200':
description: Successfully Changed
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Remote Configuration
operationId: putRemoteConfiguration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Override a single remote configuration
/api/remoteconfigs/{id}/scopes:
post:
parameters:
- description: Reference to the remote config you want to change
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddRemoteConfigurationScopeParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfiguration'
description: Updated RemoteConfiguration in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Remote Configuration
operationId: addRemoteConfigurationScope
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: add a new scope to a remote configuration
/api/remoteconfigs/{id}/scopes/{scopeId}:
delete:
parameters:
- description: Reference to the remote config you want to alter
in: path
name: id
required: true
schema:
type: string
- description: Reference to the remote config scope you want to delete
in: path
name: scopeId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RemoteConfiguration'
description: Successfully Deleted
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Remote Configuration
operationId: deleteScopeFromRemoteConfiguration
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
summary: Delete a scope from a given remote configuration
/api/configurations/return:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalizedReturnConfiguration'
description: Return config found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getReturnConfiguration
summary: Get the current configuration for returns
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalizedReturnConfiguration'
description: The return configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LocalizedReturnConfiguration'
description: The return configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Returns
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: upsertReturnConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReturnConfiguration'
description: Desired return configuration to create/update
required: true
summary: Change the tenant wide return configuration
/api/itemreturnjobs/{itemReturnJobId}/itemreturns:
get:
parameters:
- description: item return job to read the item return for
in: path
name: itemReturnJobId
required: true
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ItemReturn'
description: Get all item returns for a given item return job
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getItemReturns
summary: Get item returns
post:
parameters:
- description: Id of the item return job to create the item return for
in: path
name: itemReturnJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddItemReturnToItemReturnJob'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJob'
description: ItemReturnJob containing the newly created item return
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Create a new item return for an item return job
operationId: createItemReturn
summary: Creates a new ItemReturn
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}:
get:
parameters:
- description: item return job to read the item return for
in: path
name: itemReturnJobId
required: true
schema:
type: string
- description: id of the item return you want to read
in: path
name: itemReturnId
required: true
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturn'
description: Get a specific item return
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getItemReturn
summary: Get item return by id
delete:
parameters:
- description: id of the item return job to delete the item return for
in: path
name: itemReturnJobId
required: true
schema:
type: string
- description: id of the item return you want to delete
in: path
name: itemReturnId
required: true
schema:
type: string
- description: version of the item return job to delete the item return for
in: query
name: itemReturnJobVersion
required: true
schema:
type: number
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturn'
description: >-
item return was found and successfully deleted. Updated item return
job is returned.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Delete an item return from an item return job
operationId: deleteItemReturn
summary: Delete an item return from an item return job
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/returnedLineItems:
put:
parameters:
- description: id of the item return job the item return belongs to
in: path
name: itemReturnJobId
required: true
schema:
type: string
- description: id of the item return the returned line items belong to
in: path
name: itemReturnId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReplaceReturnedLineItems'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJob'
description: >-
The returned line items were successfully updated. Updated item
return job is returned.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
Replace returned line items of an item return of an item return job.
operationId: replaceReturnedLineItems
summary: replace returned line items
/api/itemreturnjobs:
get:
parameters:
- description: facility to filter the results
in: query
name: facilityId
required: false
schema:
type: string
- description: scannableCodes of the item return job to filter the results
in: query
name: itemReturnJobScannableCodes
required: false
schema:
type: array
items:
type: string
- description: scannableCodes of the item return to filter the results
in: query
name: itemReturnScannableCodes
required: false
schema:
type: array
items:
type: string
- description: ItemReturnJobStatus to filter the results
in: query
name: itemReturnJobStatus
required: false
schema:
type: array
items:
type: string
- description: ItemReturnStatus of an included ItemReturn to filter the results
in: query
name: itemReturnStatus
required: false
schema:
type: array
items:
type: string
- description: Term by which to search through the fields
in: query
name: searchTerm
required: false
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ItemReturnJob'
description: All Item Return Jobs matching the given parameters
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getItemReturnJobs
summary: Get all Item Return Jobs
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJobForCreation'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJob'
description: Created entity
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createItemReturnJob
summary: Creates a new ItemReturnJob
/api/itemreturnjobs/{itemReturnJobId}:
get:
parameters:
- description: id of the item return job
in: path
name: itemReturnJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJob'
description: Returns Item Return Job with the provided id
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getItemReturnJob
summary: Get Item Return Job by id
/api/itemreturnjobs/{itemReturnJobId}/actions:
post:
parameters:
- description: id of the Item Return Job
in: path
name: itemReturnJobId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJobActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJob'
description: Updated entity
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: updateItemReturnJob
summary: Updates a new ItemReturnJob
/api/itemreturnjobs/{itemReturnJobId}/itemreturns/{itemReturnId}/actions:
post:
parameters:
- description: id of the Item Return Job
in: path
name: itemReturnJobId
required: true
schema:
type: string
- description: id of the Item Return
in: path
name: itemReturnId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnActionsParameter'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ItemReturnJob'
description: Updated entity
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Returns
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: itemReturnActions
summary: Actions for a ItemReturn
/api/configurations/expiry:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: config found.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getExpiryConfiguration
summary: Get the current configuration
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: The configuration was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: The configuration was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity version conflict
tags:
- Core - Configuration
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: upsertExpiryConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryConfiguration'
description: Desired configuration to create/update
required: true
summary: Change the tenant wide configuration
/api/expiries:
get:
parameters:
- description: Status to filter the results
in: query
name: status
required: false
schema:
$ref: '#/components/schemas/ExpiryEntityStatus'
- description: ProcessRef to filter the results
in: query
name: processRef
required: false
schema:
type: string
- description: >-
StartDate to filter the results. Expiry Date of results is after or
equals the given value
in: query
name: startDate
required: false
schema:
type: string
format: date-time
example: '2020-02-03T08:45:51.525Z'
- description: >-
EndDate to filter the results. Expiry Date of results is before or
equals the given value
in: query
name: endDate
required: false
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExpiryEntity'
description: found entities in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Expiries
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getExpiries
summary: Get expiries by filter parameter
post:
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntityForCreation'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntity'
description: created entity in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Expiries
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createExpiry
summary: Create Expiry
/api/expiries/{expiryId}:
get:
parameters:
- description: id for the searched entity
in: path
name: expiryId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntity'
description: found entity in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Expiries
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getExpiry
summary: Get Expiry by Id
patch:
parameters:
- description: id of the entity to be changed
in: path
name: expiryId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntityForUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExpiryEntity'
description: changed entity in the result.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Expiries
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: updateExpiry
summary: Update Expiry
/api/health:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HealthResult'
description: Result of all tested dependencies for their health status
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Manual reroute configuration not found
tags:
- Infrastructure - Health
description: ''
operationId: healthCheck
summary: Do a health check
/api/facilities/{facilityId}/storagelocations:
get:
parameters:
- description: ID of facility from whom you want to get the storage locations
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: limit result to storage locations with scannable code
in: query
name: scannableCode
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StorageLocation'
type: array
description: >-
Facility was found & you are allowed to get the storage locations.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: ''
operationId: getFacilityStorageLocations
summary: Get the storage locations of this facility
post:
parameters:
- description: ID of facility from whom you want to create the storage location
in: path
name: facilityId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocation'
description: The storage location was successfully created.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: Creates a new storage location in this facility.
operationId: postFacilityStorageLocations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationForCreation'
description: Patch set
required: true
summary: Create a new storage location
/api/facilities/{facilityId}/storagelocations/{storageLocationId}:
get:
parameters:
- description: ID of facility from whom you want to get the storage locations
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the storageLocation
in: path
name: storageLocationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/StorageLocation'
type: array
description: >-
Facility was found & you are allowed to get the storage locations.
The result is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: ''
operationId: getFacilityStorageLocation
summary: Get the storage location of this facility
delete:
parameters:
- description: ID of facility from whom you want to delete the storage location
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the storageLocation you want to delete
in: path
name: storageLocationId
required: true
schema:
type: string
responses:
'200':
description: Storage location was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility or storage location not found
tags:
- Core - Facilities
description: ''
operationId: deleteFacilityStorageLocation
summary: Delete a storage location of a facility with the given ID
put:
parameters:
- description: ID of facility from whom you want to put the storage locations
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the storageLocation
in: path
name: storageLocationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocation'
description: Storage location was found & you were allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility or Storage Location not found
tags:
- Core - Facilities
description: >-
Replaces the current storage locations of this Facility with the
provided in the body.
operationId: putFacilityStorageLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationForReplacement'
description: Patch set
required: true
summary: Replace the storage locations of a Facility
patch:
parameters:
- description: ID of facility you want to patch the storage locations
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the storageLocation
in: path
name: storageLocationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocation'
description: Storage location was found & you were allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility or Storage location not found
tags:
- Core - Facilities
description: >
Adds new storage locations, updates existing ones and keeps the
previously present ones in the database.
1. If a storage location exists in the patch action but not in the
database it is added.
2. If a storage location exists both in the patch action and in the
database it is updated and the contents merged.
3. If a storage location exists only in the database, it is left
untouched.
operationId: patchFacilityStorageLocation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StorageLocationPatchActions'
description: Patch set
required: true
summary: Patches the storage locations of a facility with the given ID
/api/facilities/{facilityId}/zones:
get:
parameters:
- description: ID of facility from whom you want to get the zones
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Zone'
type: array
description: >-
Facility was found & you are allowed to get the zones. The result is
in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: ''
operationId: getFacilityZones
summary: Get the zones of this facility
post:
parameters:
- description: ID of facility from whom you want to create the zone
in: path
name: facilityId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Zone'
description: The zone was successfully created.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Zone not found
tags:
- Core - Facilities
description: Creates a new zone in this facility.
operationId: postFacilityZone
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneForCreation'
description: The zone to be created
required: true
summary: Create a zone
/api/facilities/{facilityId}/zones/{zoneId}:
get:
parameters:
- description: ID of facility from whom you want to get the zones
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the zone
in: path
name: zoneId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Zone'
type: array
description: >-
Zone was found & you are allowed to get it. The result is in the
body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: ''
operationId: getFacilityZone
summary: Get the zone of this facility
delete:
parameters:
- description: ID of facility from whom you want to delete the zone
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the zone you want to delete
in: path
name: zoneId
required: true
schema:
type: string
responses:
'200':
description: Zone was found & you were allowed to delete it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility or storage location not found
tags:
- Core - Facilities
description: ''
operationId: deleteFacilityZone
summary: Delete a zone of a facility with the given ID
put:
parameters:
- description: ID of facility from whom you want to put the zone
in: path
name: facilityId
required: true
schema:
type: string
- description: the ID of the zone
in: path
name: zoneId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Zone'
description: Zone was found & you are allowed to update it.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Facility not found
tags:
- Core - Facilities
description: >-
Replaces the current zone of this Facility with the provided in the
body.
operationId: putFacilityZone
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ZoneForReplacement'
description: Patch set
required: true
summary: Replace the zones of a Facility
/api/customservices/{customServiceId}:
patch:
parameters:
- description: ID of custom service you want to patch
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: >-
custom service was found & patch-set has been applied. The patched
custom service is in the body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: custom service not found
'409':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: custom service version conflict
tags:
- Core - Custom Services
operationId: patchCustomService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomServicePatchActions'
description: Patch set
required: true
summary: Patches a custom service with the given ID
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
get:
parameters:
- description: ID of custom service you want to get
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: Custom service config could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Custom Services
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getCustomService
summary: Get requested Custom service
/api/customservices/{customServiceId}/additionalinformation:
post:
parameters:
- description: ID of custom service you want to create service job for
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Custom Services
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createCustomServiceAdditionalInformation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalInformationForCreation'
description: Desired custom service to create
required: true
summary: Create a custom service additional information
/api/customservices/{customServiceId}/additionalinformation/{additionalInformationId}:
delete:
parameters:
- description: ID of custom service
in: path
name: customServiceId
required: true
schema:
type: string
- description: ID of additional information you want to delete
in: path
name: additionalInformationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Custom Services
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteAdditionalInfo
summary: Delete a custom service
put:
parameters:
- description: ID of custom service
in: path
name: customServiceId
required: true
schema:
type: string
- description: ID of additional information you want to put
in: path
name: additionalInformationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Custom Services
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: updateCustomServiceAdditionalInformation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdditionalInformationForCreation'
description: Desired custom service to create
required: true
summary: Update a custom service additional information
/api/customservices:
get:
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedCustomServices'
description: Custom service config could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Custom Services
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getCustomServices
summary: Get Custom services
post:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully updated.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CustomService'
description: The custom service was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Custom Services
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createCustomService
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomServiceForCreation'
description: Desired custom service to create
required: true
summary: Create a custom service
/api/facilities/{facilityId}/customservices:
get:
parameters:
- description: ID of facility
in: path
name: facilityId
required: true
schema:
type: string
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StrippedFacilityCustomServiceConnections'
description: Custom service connections could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Facilities
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getFacilityCustomServiceConnections
summary: Get requested Custom service connection for a facility
/api/facilities/{facilityId}/customservices/{customServiceId}:
get:
parameters:
- description: ID of facility
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnection'
description: Custom service connection could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Core - Facilities
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getFacilityCustomService
summary: Get requested Custom service connection for a facility
patch:
parameters:
- description: ID of facility
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnection'
description: The custom service connection was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Facilities
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: updateFacilityCustomServiceConnction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnectionForUpdate'
description: Desired custom service connection to create/update
required: true
summary: Update a facility custom service connection
post:
parameters:
- description: ID of facility
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnection'
description: The custom service connection was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Facilities
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: createFacilityCustomServiceConnection
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityCustomServiceConnectionForCreation'
description: Desired custom service connection to create/update
required: true
summary: Create a facility custom service connection
delete:
parameters:
- description: ID of facility
in: path
name: facilityId
required: true
schema:
type: string
- description: ID of the custom service
in: path
name: customServiceId
required: true
schema:
type: string
responses:
'200':
description: The custom service connection was successfully deleted.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Core - Facilities
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: deleteFacilityCustomServiceConnection
summary: Delete a facility custom service connection
/api/servicejobs:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobs'
description: Service Jobs could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Custom Services
operationId: getServiceJobs
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: Reference of the facility you want to filter for
in: query
name: facilityRef
required: false
schema:
type: string
- description: >-
Reference to the statuses you want to get the corresponding service
job
in: query
name: status
required: false
schema:
type: array
items:
type: string
- description: Type of channel you want to filter for
in: query
name: channel
required: false
schema:
$ref: '#/components/schemas/ServiceJobFilterChannel'
- description: Start target date range for service jobs
in: query
name: startTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: End target date range for service jobs
in: query
name: endTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: >-
Search term you want to get the corresponding service jobs. Search
will be performed on multiple fields, like tenantOrderId,
consumerName, tenantArticleId and more
in: query
name: searchTerm
required: false
schema:
type: string
summary: Get Service Jobs
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
post:
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJob'
description: The service job was successfully created.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Custom Services
operationId: createServiceJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobForCreation'
description: Desired service job to create
required: true
summary: Create a service job
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/servicejobs/{serviceJobId}:
get:
parameters:
- description: ID of service job you want to get
in: path
name: serviceJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJob'
description: Service Job could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Custom Services
operationId: getServiceJob
summary: Get requested service job
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/servicejobs/{serviceJobId}/actions:
post:
parameters:
- description: ID of service job you want to update
in: path
name: serviceJobId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJob'
description: The service job was successfully updated.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Custom Services
operationId: updateServiceJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobActionsParameter'
description: Desired change to a service job
required: true
summary: Update a service job
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/linkedservicejobs:
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobsPaginatedResult'
description: LinkedServiceJobs could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Custom Services
operationId: getLinkedServiceJobs
parameters:
- description: all entities after given Id
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
- description: facilities to filter to
in: query
name: facilityIds
required: false
schema:
type: array
items:
type: string
- description: >-
Reference to the statuses you want to get the corresponding linked
service jobs
in: query
name: status
required: false
schema:
type: array
items:
type: string
- description: sort order
in: query
name: orderBy
required: false
schema:
$ref: '#/components/schemas/LinkedServiceJobsOrderBy'
- description: type of channel you want to filter for
in: query
name: channel
required: false
schema:
$ref: '#/components/schemas/LinkedServiceJobsFilterChannel'
- description: Start target date range for linked service jobs
in: query
name: startTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: End target date range for linked service jobs
in: query
name: endTargetTime
required: false
schema:
type: string
example: '2020-02-03T08:45:50.525Z'
format: date-time
- description: >-
Search term you want to get the corresponding linked service jobs.
Search will be performed on multiple fields, like tenantOrderId,
consumerName, tenantArticleId and more
in: query
name: searchTerm
required: false
schema:
type: string
summary: Get LinkedServiceJobs
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/linkedservicejobs/{linkedServiceJobsId}:
get:
parameters:
- description: ID of LinkedServiceJobs you want to get
in: path
name: linkedServiceJobsId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobs'
description: LinkedServiceJobs could be found in response body.
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Custom Services
operationId: getLinkedServiceJobsById
summary: Get requested LinkedServiceJobs
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks:
post:
parameters:
- description: ID of LinkedServiceJobs you want to alter
in: path
name: linkedServiceJobsId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobs'
description: The ServiceJobLink was successfully added to the LinkedServiceJobs.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Custom Services
operationId: addServiceJobLink
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobLinkForAdding'
description: Desired ServiceJobLink to add
required: true
summary: Add a ServiceJobLink to an LinkedServiceJobs on root level
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId}:
post:
parameters:
- description: ID of LinkedServiceJobs you want to alter
in: path
name: linkedServiceJobsId
required: true
schema:
type: string
- description: >-
ID of ServiceJobLink you want to add the new ServiceJobLink
underneath
in: path
name: serviceJobLinkId
required: true
schema:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/LinkedServiceJobs'
description: >-
The ServiceJobLink was successfully added nested inside the
LinkedServiceJobs.
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
tags:
- Fulfillment Operations - Custom Services
operationId: addNestedServiceJobLink
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceJobLinkForAdding'
description: Desired ServiceJobLink to add
required: true
summary: Add a ServiceJobLink to an ServiceJobLInk inside the LinkedServiceJobs
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
/api/operativeprocesses:
get:
parameters:
- description: facility to filter the results
in: query
name: facilityId
required: true
schema:
type: string
- description: entity to start after
in: query
name: startAfterId
required: false
schema:
type: string
- description: number of entities to show
in: query
name: size
required: false
schema:
default: 25
type: integer
maximum: 500
minimum: 1
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/OperativeProcess'
description: All operative processes matching the given parameters
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Operative Process
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getOperativeProcesses
summary: Get all operativeProcesses
/api/operativeprocesses/{operativeProcessId}:
get:
parameters:
- description: id of the operativeProcess you want to retrieve
in: path
name: operativeProcessId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OperativeProcess'
description: Found operativeProcess by given ID
'400':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Invalid input. See response for details
'401':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Your user is not allowed to operate against this API instance
'403':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: >-
Your user, although recognized, is not authorized to use this
endpoint
'404':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ApiError'
description: Entity not found
tags:
- Fulfillment Operations - Operative Process
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getOperativeProcessById
summary: Get operativeProcess by ID
/api/articles:
get:
operationId: getArticles
summary: Search articles tenant-wide based on title or tenantArticleId
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: facilityRef
required: false
in: query
schema:
type: string
- name: searchTerm
required: false
in: query
schema:
minLength: 1
type: string
responses:
'200':
description: >-
Articles search result according to the request. The result is in
the body.
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryArticlePaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/articles/{tenantArticleId}/forecasts:
get:
operationId: getForecastsForArticle
summary: Get the forecast for a specific tenantArticleId
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: tenantArticleId
required: true
in: path
schema:
type: string
- name: period
required: false
in: query
schema:
enum:
- DAILY
type: string
responses:
'200':
description: >-
Forecast for the specified tenantArticleId. The result is in the
body.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ArticleStockForecast'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/purchaseorders/{purchaseOrderId}:
get:
operationId: getPurchaseOrder
summary: Get a Purchase Order by ID
deprecated: false
description: ''
parameters:
- name: purchaseOrderId
required: true
in: path
schema:
type: string
responses:
'200':
description: Purchase Order entity
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
put:
operationId: upsertPurchaseOrder
summary: Update or create a Purchase Order
deprecated: false
description: ''
parameters:
- name: purchaseOrderId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderForUpdate'
responses:
'200':
description: Updated/created Purchase Order entity
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
patch:
operationId: patchPurchaseOrder
summary: Partially updates a Purchase Order using a selection of fields
deprecated: false
description: ''
parameters:
- name: purchaseOrderId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderForPartialUpdate'
responses:
'200':
description: Updated Purchase Order entity
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/purchaseorders:
post:
operationId: createPurchaseOrder
summary: Create a new Purchase Order
deprecated: false
description: ''
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrderForCreation'
responses:
'201':
description: Created Purchase Order entity
content:
application/json:
schema:
$ref: '#/components/schemas/PurchaseOrder'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundprocesses:
get:
operationId: getInboundProcesses
summary: Get multiple Inbound Processes
deprecated: false
description: ''
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: sort
required: false
in: query
schema:
enum:
- ORIGIN_NAME_ASC
- REQUESTED_DATE_ASC
- LAST_MODIFIED_ASC
- ORIGIN_NAME_DESC
- REQUESTED_DATE_DESC
- LAST_MODIFIED_DESC
type: string
- name: facilityRef
required: false
in: query
schema:
type: array
items:
type: string
- name: status
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- OPEN
- PARTIAL_DELIVERY
- ON_HOLD
- CLOSED
- name: searchTerm
required: false
in: query
description: >
Matches partial values; The queries terms and therefore the result
set of the query can change in the future:
- tenantInboundProcessId
- scannableCodes
- receipts.receivedItems.tenantArticleId
- purchaseOrder.requestedItems.tenantArticleId
- purchaseOrder.supplier.name
- values of related listings
- listing.title
- listing.scannableCodes
schema:
type: string
- name: searchTermExact
required: false
in: query
description: >
Only matches complete values; The queries terms and therefore the
result set of the query can change in the future:
- tenantInboundProcessId
- scannableCodes
- receipts.receivedItems.tenantArticleId
- purchaseOrder.requestedItems.tenantArticleId
- purchaseOrder.supplier.name
- values of related listings
- listing.title
- listing.scannableCodes
schema:
type: string
- name: purchaseOrder_cancelled
required: false
in: query
schema:
type: boolean
- name: receipt_status
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- IN_PROGRESS
- FINISHED
responses:
'200':
description: Paginated result containing the matching Inbound Process entities
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
post:
operationId: createInboundProcess
summary: Create a new Inbound Process
deprecated: false
description: ''
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessForCreation'
responses:
'200':
description: Created Inbound Process entity
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcess'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundprocesses/{inboundProcessId}:
get:
operationId: getInboundProcess
summary: Get an Inbound Process by ID
deprecated: false
description: ''
parameters:
- name: inboundProcessId
required: true
in: path
schema:
type: string
responses:
'200':
description: Requested Inbound Process entity
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcess'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
delete:
operationId: deleteInboundProcess
summary: Delete an Inbound Process by ID
deprecated: false
description: ''
parameters:
- name: inboundProcessId
required: true
in: path
schema:
type: string
responses:
'200':
description: Inbound Process successfully deleted
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
patch:
operationId: Patch InboundProcess
summary: Patch an Inbound Process by ID
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: inboundProcessId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessForPatch'
responses:
'200':
description: Inbound Process successfully patched
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundprocesses/{inboundProcessId}/purchaseorder:
put:
operationId: upsertInboundProcessPurchaseOrder
summary: >-
Creates or updates the specific purchase order of an existing inbound
process.
deprecated: false
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: inboundProcessId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPurchaseOrderForUpsert'
responses:
'200':
description: Purchase order successfully updated on inbound process
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPurchaseOrder'
'201':
description: Purchase order successfully created on inbound process
content:
application/json:
schema:
$ref: '#/components/schemas/InboundProcessPurchaseOrder'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundprocesses/{inboundProcessId}/receipts:
post:
operationId: addReceiptToInboundProcess
summary: Adds a receipt to an inbound process.
deprecated: false
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: inboundProcessId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptForCreation'
responses:
'201':
description: Receipt was added to the inbound process
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceipt'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundreceiptjobs:
get:
operationId: getInboundReceiptJobs
summary: Get InboundReceiptJobs
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: facilityRef
required: false
in: query
schema:
type: array
items:
type: string
- name: status
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- OPEN
- PARTIAL_DELIVERY
- ON_HOLD
- CLOSED
- name: searchTerm
required: false
in: query
schema:
minLength: 1
type: string
- name: searchTermExact
required: false
in: query
schema:
minLength: 1
type: string
- name: fromDate
required: false
in: query
schema:
format: date-time
type: string
- name: toDate
required: false
in: query
schema:
format: date-time
type: string
responses:
'200':
description: Paginated Inbound Receipt Jobs
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptJobPaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundreceiptjobs/{inboundEntryId}:
get:
operationId: getInboundReceiptJob
summary: Get an Inbound Receipt Job by ID
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: inboundEntryId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptJob'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/receipts:
post:
operationId: createReceipt
summary: Creates a receipt
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReceiptForCreation'
responses:
'201':
description: Created inbound receipt
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/receipts/{receiptId}:
get:
operationId: getReceipt
summary: Get receipt by id
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: receiptId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
put:
operationId: putReceipt
summary: Put receipt to id
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: receiptId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptForUpdate'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
patch:
operationId: patchReceipt
summary: Patch receipt by id
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: receiptId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundReceiptForPatch'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
delete:
operationId: deleteReceipt
summary: Delete receipt by id
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: receiptId
required: true
in: path
schema:
type: string
- name: version
required: true
in: query
schema:
type: number
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Receipt'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/configurations/inventory:
patch:
operationId: upsertInventoryConfigurations
summary: Update Inventory Configuration
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryConfigurationForPatch'
responses:
'200':
description: Requested Inventory Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryConfiguration'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
get:
operationId: getInventoryConfigurations
summary: Get Inventory Configuration
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
responses:
'200':
description: Requested Inventory Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryConfiguration'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/facilities/{facilityId}/configurations/inventory:
patch:
operationId: upsertInventoryFacilityConfigurations
summary: Update Inventory Configuration for a Facility
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryFacilityConfigurationForPatch'
responses:
'200':
description: Requested Inventory Facility Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryFacilityConfiguration'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
get:
operationId: getInventoryFacilityConfigurations
summary: Get Inventory Configuration for a Facility
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityId
required: true
in: path
schema:
type: string
responses:
'200':
description: Requested Inventory Facility Configuration
content:
application/json:
schema:
$ref: '#/components/schemas/InventoryFacilityConfiguration'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/stocks/{stockId}/locationrecommendations:
get:
operationId: getStorageLocationRecommendations
summary: Get the Storage Location recommendations for a specific Stock
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: stockId
required: true
in: path
schema:
type: string
responses:
'200':
description: >-
List of Storage Locations sorted by the stock sum ascending. The
result is in the body.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StorageLocationRecommendation'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/inboundprocesses/attachments:
post:
operationId: createAttachment
summary: Creates an attachment
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InboundAttachmentForCreation'
responses:
'201':
description: Created attachment
content:
application/json:
schema:
$ref: '#/components/schemas/InboundAttachment'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/inboundprocesses/attachments/{attachmentId}/signedurl:
get:
operationId: getSignedAttachmentUrl
summary: Retrieves a signed url for an attachment
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: attachmentId
required: true
in: path
schema:
type: string
responses:
'200':
description: Signed url
content:
application/json:
schema:
type: string
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Inbound
/api/stocks/summaries:
get:
operationId: getStockSummaries
summary: Get the accumulated Stock for each Article
deprecated: false
description: ''
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: facilityServiceTypes
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- SHIP_FROM_STORE
- PICKUP
- name: facilityStatus
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- ONLINE
- SUSPENDED
- OFFLINE
- name: facilityRefs
required: false
in: query
explode: true
schema:
type: array
items:
type: string
- name: allowStale
required: false
in: query
schema:
type: boolean
- name: tenantArticleIds
required: false
in: query
explode: true
schema:
type: array
items:
type: string
- name: channelRefs
required: false
in: query
explode: true
description: >-
The channels to included under "channelAdjusted" in the stock
summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
unallocated stock."
schema:
maxItems: 50
type: array
items:
type: string
responses:
'200':
description: >-
Stock summaries was loaded & you were allowed to access it. The
result is in the body.
content:
application/json:
schema:
$ref: '#/components/schemas/StockSummaries'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/inventory/stocks/summaries:
get:
operationId: getStockSummariesDeprecated
summary: This endpoint is deprecated. Please use /api/stocks/summaries instead.
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: facilityServiceTypes
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- SHIP_FROM_STORE
- PICKUP
- name: facilityStatus
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- ONLINE
- SUSPENDED
- OFFLINE
- name: facilityRefs
required: false
in: query
explode: true
schema:
type: array
items:
type: string
- name: allowStale
required: false
in: query
schema:
type: boolean
- name: tenantArticleIds
required: false
in: query
explode: true
schema:
type: array
items:
type: string
- name: channelRefs
required: false
in: query
explode: true
description: >-
The channels to included under "channelAdjusted" in the stock
summary. Provide up to 50 channelRefs, specify "UNALLOCATED for
unallocated stock."
schema:
maxItems: 50
type: array
items:
type: string
responses:
'200':
description: >-
Stock summaries was loaded & you were allowed to access it. The
result is in the body.
content:
application/json:
schema:
$ref: '#/components/schemas/StockSummaries'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/articles/{tenantArticleId}/stockdistribution:
get:
operationId: getStockDistribution
summary: >-
Stock per Facility for a specific tenantArticleId, also includes the
Tenant-Wide Summary
deprecated: false
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: tenantArticleId
required: true
in: path
schema:
minLength: 1
type: string
- name: facilityServiceTypes
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- SHIP_FROM_STORE
- PICKUP
- name: facilityStatus
required: false
in: query
explode: false
schema:
type: array
items:
type: string
enum:
- ONLINE
- SUSPENDED
- OFFLINE
- name: facilityName
required: false
in: query
schema:
minLength: 1
type: string
- name: facilityIds
required: false
in: query
explode: true
schema:
type: array
items:
type: string
- name: channelRefs
required: false
in: query
explode: true
description: >-
The channels to included under "channelAdjusted" in each summary and
facility stock. Provide up to 50 channelRefs, specify "UNALLOCATED
for unallocated stock."
schema:
maxItems: 50
type: array
items:
type: string
responses:
'200':
description: >-
Stock distribution was loaded & you were allowed to access it. The
result is in the body.
content:
application/json:
schema:
$ref: '#/components/schemas/StockDistribution'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/facilities/{facilityId}/stocks:
get:
operationId: getFacilityStocks
summary: Get stock related to a facilityRef
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
Use Inventory
Stock instead
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: facilityId
required: true
in: path
schema:
type: string
responses:
'200':
description: Stock was loaded and you were allowed to access it.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FacilityStock'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
put:
operationId: bulkUpdateFacilityStock
summary: Update Stock in bulk facilityRef and tenantArticleId
deprecated: true
description: >-
This endpoint is deprecated and has been replaced.
Use Inventory
Stock instead
parameters:
- name: facilityId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FacilityStockBulkOperations'
responses:
'207':
description: Update Result of each targeted tenantArticleId
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FacilityStockBulkResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/stocks:
post:
operationId: createStock
summary: Create stock
deprecated: false
description: ''
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StockForCreation'
responses:
'201':
description: Stock was created.
content:
application/json:
schema:
$ref: '#/components/schemas/Stock'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
get:
operationId: getStocks
summary: Get stocks
deprecated: false
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityRef
required: false
in: query
schema:
type: string
- name: tenantArticleId
required: false
in: query
schema:
maxItems: 500
type: array
items:
type: string
- name: locationRef
required: false
in: query
schema:
maxItems: 500
type: array
items:
type: string
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
responses:
'200':
description: Stocks
content:
application/json:
schema:
$ref: '#/components/schemas/StockPaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
put:
operationId: upsertStocks
summary: Update and create many stocks at once
deprecated: false
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StocksForUpsert'
responses:
'200':
description: Stock upsert result
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StockUpsertOperationResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/stocks/{stockId}:
put:
operationId: updateStock
summary: Update stock
deprecated: false
description: ''
parameters:
- name: stockId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/StockForUpdate'
- type: object
properties:
value:
type: integer
minimum: 0
format: int32
locationRef:
type: string
nullable: true
required:
- value
not:
required:
- version
responses:
'200':
description: Stock
content:
application/json:
schema:
$ref: '#/components/schemas/Stock'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
delete:
operationId: deleteStock
summary: Delete stock
deprecated: false
description: ''
parameters:
- name: stockId
required: true
in: path
schema:
type: string
responses:
'200':
description: Stock was deleted.
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
get:
operationId: getStock
summary: Get stock
deprecated: false
description: ''
parameters:
- name: stockId
required: true
in: path
schema:
type: string
responses:
'200':
description: Stock
content:
application/json:
schema:
$ref: '#/components/schemas/Stock'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/stocks/actions:
post:
operationId: performStocksActions
summary: Perform stocks actions
deprecated: false
description: >-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StockAction'
responses:
'200':
description: Stock action result
content:
application/json:
schema:
$ref: '#/components/schemas/StockActionResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/safetystocks:
get:
operationId: getSafetyStocks
summary: Get all Safety Stocks
deprecated: false
description: ''
parameters:
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
- name: tenantArticleId
required: false
in: query
schema:
type: string
- name: facilityRef
required: false
in: query
schema:
type: string
responses:
'200':
description: Available Safety Stocks
content:
application/json:
schema:
$ref: '#/components/schemas/SafetyStocksPaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
put:
operationId: bulkUpdateSafetyStock
summary: Update Safety Stocks in bulk
deprecated: false
description: ''
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SafetyStockBulkOperations'
responses:
'207':
description: Result of the bulk operations
content:
application/json:
schema:
$ref: '#/components/schemas/SafetyStockBulkOperationResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/safetystocks/{safetyStockId}:
delete:
operationId: deleteSafetyStock
summary: Delete a single Safety Stock
deprecated: false
description: ''
parameters:
- name: safetyStockId
required: true
in: path
schema:
type: string
responses:
'200':
description: Result of the bulk operations
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Stocks
/api/configurations/notifications:
get:
operationId: getNotificationCenterConfig
summary: Returns the notification center configuration.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
responses:
'200':
description: The notification center configuration was successfully returned.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
put:
operationId: upsertNotificationCenterConfig
summary: Creates or updates an existing notification center configuration.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
- type: object
allOf:
- $ref: '#/components/schemas/NotificationCenterConfigForCreation'
not:
required:
- version
responses:
'200':
description: Notification center configuration was successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'201':
description: Notification center configuration was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'400':
description: Invalid input. See response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: A version conflict occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
/api/configurations/notifications/channels/{channelId}:
delete:
operationId: deleteNotificationCenterConfigChannel
summary: Deletes a notification center config channel.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: channelId
required: true
in: path
schema:
type: string
- name: version
required: true
in: query
schema:
type: number
responses:
'200':
description: Notification center config channel was successfully deleted.
'400':
description: Invalid input. See response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: A version conflict occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
/api/configurations/notifications/actions:
post:
operationId: executeNotificationCenterConfigAction
summary: Executes an action to manipulate the notification center configuration.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AddChannelAction'
- $ref: '#/components/schemas/UpdateChannelByIdAction'
responses:
'200':
description: Notification center configuration action was successfully executed.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'400':
description: Invalid input. See response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: A version conflict occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
/api/facilities/{facilityRef}/configurations/notifications:
get:
operationId: getNotificationCenterFacilityConfig
summary: Returns the notification center facility configuration.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityRef
required: true
in: path
schema:
type: string
responses:
'200':
description: >-
The notification center facility configuration was successfully
returned.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
put:
operationId: upsertNotificationCenterFacilityConfig
summary: >-
Creates or updates an existing notification center facility
configuration.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityRef
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/NotificationCenterConfigForUpdate'
- type: object
allOf:
- $ref: '#/components/schemas/NotificationCenterConfigForCreation'
not:
required:
- version
responses:
'200':
description: Notification center facility configuration was successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'201':
description: Notification center facility configuration was successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'400':
description: Invalid input. See response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: A version conflict occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
/api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}:
delete:
operationId: deleteNotificationCenterFacilityConfigChannel
summary: Deletes a notification center facility config channel.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityRef
required: true
in: path
schema:
type: string
- name: channelId
required: true
in: path
schema:
type: string
- name: version
required: true
in: query
schema:
type: number
responses:
'200':
description: >-
Notification center facility config channel was successfully
deleted.
'400':
description: Invalid input. See response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: A version conflict occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
/api/facilities/{facilityRef}/configurations/notifications/actions:
post:
operationId: executeNotificationCenterFacilityConfigAction
summary: >-
Executes an action to manipulate the notification center facility
configuration.
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: facilityRef
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AddChannelAction'
- $ref: '#/components/schemas/UpdateChannelByIdAction'
responses:
'200':
description: >-
Notification center facility configuration action was successfully
executed.
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationCenterConfig'
'400':
description: Invalid input. See response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'409':
description: A version conflict occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Core - Notification Center
/api/availabilitychannels:
post:
operationId: createAvailabilityChannel
summary: Create a new Availability Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannelForCreation'
responses:
'200':
description: The created Availability Channel
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannel'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
get:
operationId: getAvailabilityChannels
summary: Get all Availability Channels
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: searchTerm
required: false
in: query
schema:
type: string
- name: searchTermExact
required: false
in: query
schema:
type: string
- name: strategy
required: false
in: query
schema:
enum:
- REGULAR
- IRON_RESERVE
- RESTRICT
type: string
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
responses:
'200':
description: Available Availability Channels
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannelPaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
/api/availabilitychannels/{availabilityChannelId}:
put:
operationId: replaceAvailabilityChannel
summary: Replace an existing Availability Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannelForReplacement'
responses:
'200':
description: The replaced Availability Channel
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannel'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
get:
operationId: getAvailabilityChannelById
summary: Get an Availability Channel by its id
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
responses:
'200':
description: The Availability Channel
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityChannel'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
delete:
operationId: deleteAvailabilityChannel
summary: Delete an existing Availability Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
responses:
'200':
description: The deleted Availability Channel
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
/api/availabilitychannels/{availabilityChannelId}/groups:
get:
operationId: getGroupsUnderChannel
summary: Get Groups under Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
- name: searchTerm
required: false
in: query
schema:
type: string
- name: searchTermExact
required: false
in: query
schema:
type: string
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
responses:
'200':
description: Available Groups
content:
application/json:
schema:
$ref: >-
#/components/schemas/AvailabilityAllocationGroupPaginatedResult
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
post:
operationId: createGroupUnderChannel
summary: Create a Group under Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: >-
#/components/schemas/AvailabilityAllocationGroupForCreationUnderChannel
responses:
'200':
description: The created Group
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationGroup'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}:
put:
operationId: replaceGroupUnderChannel
summary: Replace a Group under Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
- name: groupId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationGroupForReplacement'
responses:
'200':
description: The replaced Group
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationGroup'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
get:
operationId: getGroupUnderChannelById
summary: Get Groups under Channel by its ID
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: availabilityChannelId
required: true
in: path
schema:
type: string
- name: groupId
required: true
in: path
schema:
type: string
responses:
'200':
description: The Group
content:
application/json:
schema:
$ref: >-
#/components/schemas/AvailabilityAllocationGroupPaginatedResult
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
delete:
operationId: deleteGroupUnderChannel
summary: Delete an existing Group under Channel
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: groupId
required: true
in: path
schema:
type: string
- name: availabilityChannelId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations:
get:
operationId: getAllocationsUnderGroup
summary: Get Allocations under Group
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: groupId
required: true
in: path
schema:
type: string
- name: availabilityChannelId
required: true
in: path
schema:
type: string
- name: searchTerm
required: false
in: query
schema:
type: string
- name: searchTermExact
required: false
in: query
schema:
type: string
- name: size
required: false
in: query
schema:
minimum: 1
maximum: 100
default: 25
type: number
- name: startAfterId
required: false
in: query
schema:
type: string
responses:
'200':
description: Available Allocations
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationPaginatedResult'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
post:
operationId: createAllocationUnderGroup
summary: Create a new Allocation under Group
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: groupId
required: true
in: path
schema:
type: string
- name: availabilityChannelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationForCreationUnderGroup'
responses:
'200':
description: The created Allocation
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocation'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}:
put:
operationId: replaceAllocationUnderGroup
summary: Replace an existing Allocation under a group
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: groupId
required: true
in: path
schema:
type: string
- name: allocationId
required: true
in: path
schema:
type: string
- name: availabilityChannelId
required: true
in: path
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocationForReplacement'
responses:
'200':
description: The replaced Allocation
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocation'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
get:
operationId: getAllocationUnderGroupById
summary: Get an Allocation under a Group by its id
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: groupId
required: true
in: path
schema:
type: string
- name: allocationId
required: true
in: path
schema:
type: string
- name: availabilityChannelId
required: true
in: path
schema:
type: string
responses:
'200':
description: The Allocation
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityAllocation'
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
delete:
operationId: deleteAllocationUnderGroup
summary: Delete an existing Allocation under Group
deprecated: false
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
parameters:
- name: allocationId
required: true
in: path
schema:
type: string
- name: groupId
required: true
in: path
schema:
type: string
- name: availabilityChannelId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
'401':
description: Your user is not allowed to operate against this API instance
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'403':
description: Your user, although recognized, is not authorized to use this
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'404':
description: The requested entity was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
tags:
- Inventory Management - Channel Availability
/graphql:
get:
responses:
'200':
description: The GraphQL playground
tags:
- Infrastructure - GraphQL
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: getGraphQLPlayground
summary: Get the GraphQL playground
post:
responses:
'200':
description: The GraphQL command was successfully executed.
'400':
description: GraphQL validation error
tags:
- Infrastructure - GraphQL
description: |-
This part of the API is currently under development.
That means that this endpoint, model, etc. can contain breaking changes
and / or might not be available at all times in your API instance. It
could disappear also without warning. Thus, it currently does not fall
under our SLA regulations. For details on this topic please check our
documentation
operationId: executeGraphQLCommand
summary: Endpoint for executing GraphQL commands
components:
requestBodies:
MeasurementUnitForCreation:
content:
application/json:
schema:
$ref: '#/components/schemas/MeasurementUnitForCreation'
required: true
schemas:
AbstractArticle:
properties:
customAttributes:
description: >-
Attributes that can be added to the article. These attributes cannot
be used within fulfillment processes, but it could be useful to have
the informations carried here.
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:
example: Cologne Water
type: string
weight:
type: number
description: weight value is in gram
minimum: 0
required:
- title
- tenantArticleId
type: object
xml:
name: AbstractArticle
AbstractCarrierCredentials:
discriminator:
propertyName: key
properties:
key:
type: string
required:
- key
type: object
xml:
name: AbstractCarrierCredentials
AbstractFacilityCarrierConfiguration:
discriminator:
propertyName: key
properties:
key:
type: string
required:
- key
type: object
xml:
name: AbstractFacilityCarrierConfiguration
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
AbstractModificationAction:
discriminator:
propertyName: action
properties:
action:
description: ''
enum:
- AddAllowedValueToTag
- ModifyPickJob
- ModifyPickJobLastEditor
- RestartPickJob
- ResetPickJob
- CancelPickRun
- CancelHandoverjob
- AbortPickJob
- FinishPickRun
- StartPickRun
- ModifyPickLineItem
- ModifyPickRunLineItem
- ModifyPackJob
- ModifyPackLineItem
- ModifyFacility
- ModifyListing
- ModifyRetainedOfflineStock
- ModifyListingReactivationAfter
- ModifyUser
- ModifyShipment
- ModifyHandoverjob
- ModifyCarrier
- ModifyShortpick
- ModifyReturn
- ModifyReturnLineItem
- ModifyRoutingPlan
- ModifyFence
- ModifyRating
- ModifyTimingMode
- ModifyGlobalRoutingConfiguration
- ModifyOrderSplit
- ModifyPrioritization
- ModifyLoadUnitType
- ModifyFeature
- ModifyParcel
- ModifyParcelLoadUnit
- ModifyRestowItem
- RemovePickJobFromPickRunAction
- ModifyPartialStock
- AddTagsToProcess
- AssignFacilityToProcess
- ModifyStorageLocation
- ModifyPackingContainerType
- ModifyPackingContainerTypeIcon
- ReplaceCodesInPackingContainer
- ReplaceLoadUnitLineItems
- AddLineItemToPackingContainer
- RemoveLineItemFromPackingContainer
- UpdateLineItemOnPackingContainer
- ModifyCustomService
- UnlockOrder
example: